簡介
mkdocs 是一款在線文檔生成工具，可以生成比較漂亮的在線文檔。比如我個人的C++筆記就是用它生成的：https://demon90s.github.io/CppStudy/
其實 mkdocs 功能就是把一堆 markdown 文檔生成成一些 html 的靜態頁面。
mkdocs 的官網是：
安裝
官網安裝參考：
https://www.mkdocs.org/user-guide/installation/
我測試安裝的環境是 VirtualBox 中的 CentOS7 。關於如何在 VirtualBox 中安裝 CentOS7 可以參考我這篇 BLOG ：https://www.cnblogs.com/demon90s/p/6086350.html
安裝步驟
$ yum install python36
$ wget ftp://lovemiemie.xyz/pub/install_package/ubuntu/get-pip.py
$ python3.6 get-pip.py
$ pip install mkdocs
$ mkdocs --version
PS: 如果之前已經有安裝了更低版本的 python ，那么使用pip前，最好加上 python3.6 -m 。比如 python3.6 -m pip install mkdocs 。不然可能會因為版本問題報錯。
創建一個 mkdocs 項目
$ mkdocs new my-project
$ cd my-project
啟動服務
mkdocs serve -a 10.0.2.15:8001
PS: 10.0.2.15 是虛擬機的默認地址。
虛擬機做端口轉發，關於端口轉發也可以參考上面引用的博客。
打開瀏覽器即可訪問 127.0.0.1:8001
創建靜態頁面
mkdocs build
如何發布到 github page
首先需要有一個 github 賬號，然后創建一個 git 倉庫，在這里初始化 mkdocs 目錄，之后就可以使用命令 mkdocs gh-deploy 來創建一個 github page 的分支，完畢后，mkdocs會打印出網站地址，然后就可以在網頁上訪問了。
PS： 由於目前國內網站訪問 github 很不穩定，所以其實有一個雲主機，將其部署在雲主機上面也不錯。方法就是先創建靜態頁面，然后將它放到適當的網站文件目錄。
material 主題
我比較推薦使用 material 主題，可以在它的官網查看更多關於它的資料 https://squidfunk.github.io/mkdocs-material
安裝：
pip install mkdocs-material
更新：
pip install --upgrade mkdocs-material
查詢當前版本：
pip show mkdocs-material
主題的相關設置參考：
https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/