跳转至

欢迎来到 MkDocs

如需完整文档,请访问 mkdocs.org

命令

  • mkdocs new [dir-name] - 创建一个新项目。
  • mkdocs serve - 启动实时重新加载文档服务器。
  • mkdocs build - 构建文档站点。
  • mkdocs -h - 打印帮助信息并退出。

项目布局

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