MkDocs教程
使用MkDocs在ReadTheDocs上托管文档.
基本命令
mkdocs new [dir-name]
- 创建一个新项目.mkdocs serve
- 启动文档服务器.mkdocs build --clean
- 生成站点文件.mkdocs help
- 帮助信息.
项目布局
mkdocs.yml # 配置文件.
docs/
index.md # 文档主页.
... # 其他页面, 图片和文件.
使用MkDocs在ReadTheDocs上托管文档.
mkdocs new [dir-name]
- 创建一个新项目.mkdocs serve
- 启动文档服务器.mkdocs build --clean
- 生成站点文件.mkdocs help
- 帮助信息.mkdocs.yml # 配置文件.
docs/
index.md # 文档主页.
... # 其他页面, 图片和文件.