OnePress 使用文件系统路由,即页面的文件路径会被简单地映射为路由路径,这会使整个项目的路由变得非常直观。
OnePress 的默认路由规则是,收集 docs
目录下的以 .md
.mdx
.page.js
.page.jsx
.page.ts
.page.tsx
结尾的文件作为页面。
假设你的项目结构如下:
tree
1└─ <root>2 ├─ guide3 │ ├─ getting-started.md4 │ └─ index.md5 ├─ contributing.md6 └─ README.md
实际得到的路由映射规则是:
文件路径 | 路由路径 |
---|---|
/README.md | / |
/contributing.md | /contributing |
/guide/index.md | /guide |
/guide/getting-started.md | /guide/getting-started |