使用 Mkdocs 在 Github 上快速部署文章

概述

为项目编写文档，网上比较多的推荐是使用 ReadTheDocs ，以及配合 sphinx 来使用，然后经过一番尝试，发现 sphinx 对 markdown 格式的支持并不是太好，在连接上常常会出现问题，而且个人感觉 ReadTheDocs 网站上的管理功能也不是那么符合我们的习惯，于是向寻找一款替代方案，经过一番搜索，找到了一款叫 MkDocs 的工具。
MkDocs 架构简单，工具可以自动创建一个配置文件 mkdocs.yml，以及一个 docs 文件夹，可以通过简单的配置，然后往 docs 文件夹上添加 markdown 文件作为页面即可。完成后工具自带部署到 Github 上的功能，通过简单的设置，就可以轻松使用 GitPage 展示项目文档。
具体细节可以参考 MkDocs 官网文档：
MkDocs 中文官网
MkDocs 英文官网

MkDocs 安装

使用 pip 安装 mkdocs。

pip install mkdocs

安装完成后，可以检查以下 MkDocs 是否能正确安装