MkDocs是什麼?

MKDocs就是一個能快速，簡單，優雅的生成靜態文件站點的專案。文件用Markdown書寫，目錄用YAML配置，弄好之後你可以把它放到Github的Pages 上，或者自己伺服器上就可以了。並且也有好幾套UI供你選擇MkDocs UI，特別適合那些做開源專案的童鞋，生成說明文件使用。總的來說，就是省時省力，效果還不錯

安裝

我的機子裝了brew，所以可以直接命令列安裝軟體。

1. 安裝Python

   在終端輸入下面指令：brew install python

   檢視版本：

   python --version
   Python 2.7.10

2. 安裝mkdocs

   在終端輸入下面指令：pip install mkdocs

   檢視版本：

   mkdocs --version
   mkdocs, version 0.15.3

實戰一下

1. 在終端輸入下面指令：mkdocs new project。建立一個名為project的mkdocs的專案。

2. 執行專案：

   cd project
   mkdocs serve

3. 顯示如下：

   Running at: http://127.0.0.1:8000/

4. 在瀏覽器中訪問上面的連結即可。

解釋一下

1. 在project檔案下，會有一個doc目錄和一個mkdocs.yml檔案，.yml就是配置檔案。修改裡面的內容就可以修改樣式以及需要新增的展示內容。

2. 給出幾個樣式：

   theme: readthedocs
   theme
    
   : bootstrap
   theme: amelia
   theme: cosmo
   theme: slate
   theme: yeti
   theme: united
   theme: journal

其他指令

$mkdocs build /*生成網站的site目錄，裡面有一些靜態資源*/
$mkdocs build --clean
$mkdocs --help

說明

系統：macOS

其他詳細的說明，可以去官網檢視MKDocs。