跳转至

开发者教程

欢迎参与 Everyone Create Community(每个人创作社区)文档共建。本板块按角色和场景组织教程,从零基础到进阶:

教程 内容 适合谁
环境搭建 安装 Python、MkDocs、克隆仓库,跑起本地预览 首次参与者
Markdown 写作规范 标题层级、列表、表格、图片引用的统一写法 所有撰稿人
提交与上线流程 分支、Commit、Pull Request 到自动上线的完整链路 所有撰稿人
导航与站点配置 mkdocs.yml 的 nav 折叠菜单写法与新页面登记 进阶维护者

学习路径建议

  1. 第一次参与:按顺序读完 环境搭建 和 Markdown 写作规范,即可开始写文档
  2. 写完之后:按 提交与上线流程 提交,等待审核合并
  3. 想帮社区调整站点结构(加栏目、改导航):再看 导航与站点配置

快速备忘

mkdocs serve      # 本地预览,保存即刷新
mkdocs build      # 构建静态产物到 site/

遇到问题先查 关于本站 的常见说明,仍无法解决可在 GitHub 仓库 提 Issue。