使用Mkdocs構建你的項目文檔


使用Mkdocs構建你的項目文檔

環境搭建

安裝必需軟件

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

windows 10 x64

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

python 3.4 x86版本(必備依賴)

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

pip(pyton包管理器)

下載地址: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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM