使用

配置文件

mkdocs.yml

site_name: XXX
docs_dir: docs
nav:
    - home: index.md
    - about: other/about.md
theme:
    - name: readthedocs

文档源

docs/

文档格式

Markdown
注：

1. 配置文件目录等级必须大于等于文档源，即docs_dir可配置为子目录
2. 不同主题下可能有特殊的要求，详情查看官方文档
3. 参考文档必须以官方文档为准，其他翻译中文文档可能不准，即必须参考第一手资料
4. 需使用自动化工具统一格式化Markdown语法规范，避免Markdown解析不规范

   参考

mkdocs/mkdocs: Project documentation with Markdown. (github.com)

MkDocs