跳转至

提交与上线流程

本教程说明文档从本地修改到正式上线的完整链路。撰写规范见 Markdown 写作规范,环境问题见 环境搭建。

流程总览

修改文档 → 本地预览 → 提交分支 → Pull Request → 审核合并 → 构建上线

1. 修改文档

在 docs/ 目录中编辑或新增 .md 文件。新页面必须在 mkdocs.yml 的 nav 中登记才会出现在导航里(写法见导航与站点配置)。

2. 本地预览

mkdocs serve

浏览器打开 http://127.0.0.1:8000,确认:

  • 标题层级、表格、列表渲染正常
  • 图片能显示、站内外链接可跳转
  • 搜索能搜到你新增的关键词

3. 提交分支

git checkout -b docs/my-edit        # 新建分支,起一个见名知意的名字
git add .
git commit -m "docs: 简要说明本次改动"
git push origin docs/my-edit

Commit 信息建议以 docs: 开头,一句话说明改了什么。

4. Pull Request

推送后打开 GitHub 仓库页面,点击 Compare & pull request:

  • 标题一句话概括改动
  • 正文写明:改了哪些页面、为什么改、截图(涉及排版时)
  • 提交后等待审核

不装本地环境也可以:在 GitHub 网页上打开要改的文件,点铅笔图标直接编辑,保存时选择「新建分支并发起 PR」,效果相同。

5. 审核合并与上线

维护者审核通过后合并入 main,随后构建静态产物推送发布,GitHub Pages 自动更新,通常 1 分钟内生效。

合并后看不到变化?多为浏览器缓存,强制刷新(Ctrl+F5)即可。

注意事项

!!! warning "注意" docs/CNAME 与仓库根目录 release/update/ 子站由维护者管理,普通贡献请勿改动。