MkDocs安装教程

安装 MkDocs

• 使用以下命令进行安装MkDocs

  pip install mkdocs
  

• 安装material主题

  pip install mkdocs-material
  

• 安装完成后验证是否安装成功

  mkdocs --version
  

创建 MkDocs 项目

mkdocs new <项目名称>

启动本地服务器

mkdocs serve

- 在浏览器打开 http://127.0.0.1:8000进行预览。

生成静态文件

mkdocs build

部署到Github

mkdocs gh-deploy

参考文档

• Material for MkDocs - Material for MkDocs 中文文档
• 最牛逼的Python文档生成工具——MkDocs，手把手教你搭建文档网站 | 极客之音
• Material for MkDocs