北洋小飞协技术文档

文档仓库分支说明（git branch）

• main分支为开发的主分支，部署后为文档的 dev版本，用于内部使用 （需要登录访问）。（我们主要在这个分支上开发）
• (DEPRECATED, 现在采用workflow自动同步，要将部分文档对外，仅需修改 public.yml即可) stable分支为对外开放的稳定分支，部署后为文档的 stable版本，用于技术分享（无需登录）。
• gh-pages为github workflow自动部署的静态网站分支（存放网站资源，一般情况下这个分支是自动部署的，请不要动它）。

文档编写规范

待补充。

文档提交说明

请创建一个新的分支，然后提交PR。

注意

1. 请不要直接在main分支上进行修改。main分支为内部使用的稳定主分支，不要直接修改。请采用PR的方式进行修改，然后由管理员进行合并。不要直接在 main分支上进行修改。
2. 请不要直接在 gh-pages分支上进行修改。gh-pages分支为github workflow自动部署的静态网站分支，所有的修改都会被覆盖。
3. 更新对外开放目录 public.yml时请 务必 和社团所有组协商好对外开放的内容。

本地环境配置

请参考mkdocs使用说明。