#约定式路由

#什么是约定式路由

Athen 使用的是文件系统路由，页面的文件路径会简单的映射为路由路径，这样会让整个项目的路由非常直观。

例如，如果在 docs 目录中有一个名为 foo.md 的文件，则该文件的路由路径将是 /foo。

#映射规则

Athen 会自动扫描根目录和所有子目录，并将文件路径映射到路由路径。例如，如果你有以下的文件结构：

docs
├── foo
│   └── bar.md
└── foo.md

在之前的入门项目中，启动脚本是 athen dev docs，所以根目录是 docs。

那么 bar.md 的路由路径会是 /foo/bar，foo.md 的路由路径会是 /foo。

具体映射规则如下：

#自定义行为

如果要自定义路由行为，可以使用配置文件中的 route 字段。例如：

import { defineConfig } from 'athen';

export default defineConfig({
  route: {
    // 这些文件将从路由中排除（支持 glob 模式）
    exclude: ['custom.tsx', 'component/**/*']
    // 这些文件将包含在路由中（支持 glob 模式）
    include: ['other-dir/**/*'],
  }
});

更多细节可以参考 基础配置。