mkdocs 的安装与使用¶

安装 mkdocs¶

pip install mkdocs

初始化项目¶

mkdocs new 项目名称

生成如下的文件：

docs里面装的就是具体的页面文件，yml文件是页面映射配置，复杂的功能可用HTML语言书写。

书写*.md文件¶

Markdown书写规范和语法见 1.2

本地部署¶

mkdocs serve

远程部署到GitHub Pages¶

在GitHub仓库中，将默认分支设置为gh-pages.运行以下命令：

mkdocs gh-deploy

这将把site文件夹中的内容推送到gh-pages分支上，使你的文档通过GitHub Pages可访问。

对于本篇文档，运行根目录下gh-deploy.bat文件即可部署到Github Pages。

附录¶

教程网站：

mkdocs-tutorial

对应的Github网页：

mkdocs-tutorial Github