引言

简介

MkDocs是一个简单、便捷的工程文档生成器。默认源文件格式为Markdown，通过一个YAML文件进行配置。其拥有如下优势：

1. 不限制部署
2. 有一堆好看的主题可供MkDocs使用。默认提供了mkdocs和readthedocs
3. 内置的dev服务器允许编写文档时预览文档。它甚至可以在保存更改时自动重新加载和刷新浏览器
4. 通过自定义主题，使项目文档看起来正是您想要的样子

安装

$ pip install mkdocs
$ mkdocs --version
mkdocs, version 1.1.2 from /home/zj/anaconda3/lib/python3.7/site-packages/mkdocs (Python 3.7)