使用Mkdocs構建你的專案文件

weixin_33896726發表於2017-09-10

使用Mkdocs構建你的專案文件

環境搭建

安裝必需軟體

作者是在windows下安裝的,如果是linux或mac使用者,官網有更詳細的安裝說明。

windows 10 x64

當然還有廣大的windows 7/8 使用者,也是適用的。

python 3.4 x86版本(必備依賴)

下載地址:https://www.python.org/downloads/release/python-344rc1/

pip(pytone包管理器)

下載地址:https://pypi.python.org/pypi/pip

下載檔案並解壓到某個資料夾下,並使用CMD進入到解壓後的資料夾目錄

執行安裝命令:

cd C:\Python34\pip-9.0.1
C:\Python34\pip-9.0.1>python setup.py install

安裝mkdocs(把markdown轉成靜態html)

pip install mkdocs

埠被佔用

開啟MkDocs的伺服器,報以下錯:[WinError 10013] 以一種訪問許可權不允許的方式做了一個訪問套接字的嘗試。

原因是預設的8000埠被佔用,在官網文件中找到修改埠的方法:

https://markdown-docs-zh.readthedocs.io/zh_CN/latest/user-guide/configuration/

例如:我修改埠號為8001

:: Run on port 8001, accessible over the local network.(http://127.0.0.1:8001/) , if 8000 port is used by other.
mkdocs serve --dev-addr=0.0.0.0:8001

安裝部分參考文章:http://www.cnblogs.com/yuanzm/p/4089856.html

編輯站點

使用markdown格式編寫文件,並在mkdocs.yml 中組織目錄結構

關於markdown的知識,可以參考我的部落格:Markdown(MD)寫作

mkdocs.yml的配置資訊,請參考:https://markdown-docs-zh.readthedocs.io/zh_CN/latest/#_10

生成站點

生成靜態的html,執行以下命令會建立一個site目錄,並把生成後的靜態html放在site目錄。你可以對這些靜態html進行版本控制。

mkdocs build

PS.如果你是託管在github上,那麼使用gh-deploy也許更適合你。

釋出站點

如果你的網站是託管在github在,那麼事情會變的很簡單

示例:預設釋出到gh-pages分支,並在生成靜態html時,清理不存在的檔案

mkdocs gh-deploy --clean

deploy文件:http://www.mkdocs.org/user-guide/deploying-your-docs/

建議在開發階段使用mkdocs serve

釋出階段使用 mkdocs gh-deploy

MkDocs中文文件:https://markdown-docs-zh.readthedocs.io/zh_CN/latest/#mkdocs

相關文章