跳到正文

编辑与预览

找到 Markdown 源文件,修改内容并在本地检查页面、目录和链接。

定位源文件

修改本指南时,可以通过页面底部的“在 GitHub 编辑此页”打开对应文件。多页改动适合在本地分支中一起编辑。翻译其他项目的文档时,按该项目的贡献说明定位源文件和预览命令。

本指南的 Markdown 位于 content/docs/。每个栏目对应一个目录,文章直接放在栏目目录下。文件和目录名称开头的数字控制导航顺序,页面地址省略数字前缀。例如,03.typography/01.overview.md 对应 /docs/typography/overview。用 .navigation.yml 设置栏目标题和 Lucide 图标。

遇到多个文件同时出现相同内容时,先按源文件和生成内容判断实际维护位置。通过 GitHub 网页编辑单页时,检查目标分支、文件和最后提交的差异。需要同时调整目录、共享片段和多个链接时,把这些改动放在同一次本地预览中验证。

预览本指南

在仓库根目录安装依赖并启动开发服务。

pnpm install
pnpm run dev

打开终端显示的本地地址,再进入 /docs。核对页面标题、侧栏顺序和本页目录,逐个点击新增链接。新增代码示例时,在文中声明的环境里复制执行,并检查输出是否与说明一致。

按改动选择预览入口

新增或移动页面时,从导航打开一次,再直接访问页面地址。改动标题时,测试原有入口和新页内目录。引用组件、表格、图片或代码时,分别从桌面和窄屏检查内容。发现源文件正确但页面不同步时,可以重开预览并对照浏览器正在访问的本地地址。