文档站指南
本指南面向战队所有成员,教你如何参与 GMaster 文档站的建设与维护。
文档站基于 MkDocs Material 构建,托管于 GitHub,采用 PR 工作流协作。无论你是软件组、硬件组、机械组、视觉组还是宣运组的成员,都可以按照本指南贡献内容。
- MkDocs 介绍与配置 — 文档站技术栈、文件结构、如何新增页面与修改导航
- Markdown 语法速查 — 标题、图片、链接、代码块、引用、表格等常用语法
- Git 工作流 — 如何 Fork、Clone、提交 PR,参与协作开发
- 文档规范 — 如何写出清晰、可维护的技术文档
- 问题反馈 — 如何提交 Issue 或联系作者
- 建站者说 — 文档站的由来与愿景