欢迎来到 MkDocs

更多更全的文档参考 mkdocs.org.

命令

• mkdocs new [dir-name] - 创建一个新的项目
• mkdocs serve - 启动实时重新加载文档服务器。
• mkdocs build - 构建静态文档页面。
• mkdocs gh-deploy - 将您的文档部署到 GitHub Pages。
• mkdocs -h - 打印帮助信息并退出。

项目布局

mkdocs.yml    # 配置文件。
docs/
    index.md  # 文档主页。
    ...       # 其他markdown页面、图像和其他文件。