Mkdocs

相关链接：

1. mkdocs中文文档
2. MkDocs Themes
3. mkdocs源代码

参考文章

1. Mkdocs 配置和使用 | 飞污熊博客 (xncoding.com)

编写文档

1. 文档写在.\docs文件夹下
2. 编写首页.\docs\index.md
3. 在项目根目录下，创建mkdocs配置文件mkdocs.yml
4. mkdocs serve本地调试

部署

Github

1. 运行mkdocs gh-deploy命令，工具会将相应内容推送到gh-pages分支上
2. 在Github项目设置中，在GitPage中选择gh-pages分支
3. 通过https://<user-name>.github.io/<project-name>访问

Gitee

1. mkdocs build生成静态文件，位于.\site
2. 推送.\mkdocs.yml、.\docs\*、.\site\*到仓库当中
3. 开启GiteePages服务，选择对应分支
4. 通过https://<user-name>.gitee.io/<project-name>访问

Gitee

参考链接：

1. 使用Gitlab Pages发布Obsidian笔记