项目结构

.
├── docs/
│   ├── api/
│   ├── assets/
│   ├── guides/
│   ├── about/
│   └── index.md
├── mkdocs.yml
└── requirements.txt

约定

docs/index.md

站点首页

docs/guides/

使用指南、部署文档、FAQ

docs/api/

接口与能力说明

docs/about/

背景、路线图、维护说明