快速开始
这个项目使用 Next.js App Router 和 Nextra Docs Theme 构建,适合把团队文档集中到一个可搜索的站点里。
项目结构
- layout.jsx
- page.jsx
- _meta.js
- index.mdx
- getting-started.mdx
- mdx-components.js
- next.config.mjs
- package.json
常用命令
npm install
npm run dev
npm run build
npm run startnpm run build 完成后会自动执行 pagefind,为搜索框生成静态索引。
如何新增文档
新建一个 .mdx 文件
把文档放进 content/ 或其子目录中,例如 content/workflows/oncall.mdx。
在对应目录的 _meta.js 里登记标题
这样左侧导航可以按你指定的顺序和名称显示。
写好 title 和 description
这两项会用于页面标题、搜索结果和分享摘要。
如果你把文档放进了新的文件夹,记得同时创建该文件夹下的 _meta.js,否则侧边栏顺序会不够可控。
推荐下一步
- 把你们现有的“项目介绍”迁移到根目录文档
- 把“发布流程”和“回滚手册”放进
content/workflows/ - 把常用模板放进
content/templates/