什么是 mkdocs
mkdocs是一個用來生成文檔的工具，它可以用來將一組 markdown 格式的文件轉換成 一個有結構的 html 頁面错沃。便于我們?yōu)轫椖縿?chuàng)建API文檔或者幫助手冊。
安裝 mkdocs
pip install mkdocs
當然也可以使用 apt礼饱，brew夯膀，cherry等工具裝。
Get Started
使用如下命令創(chuàng)建一個文檔工程,
mkdocs new <project name>
mkdocs運行主要需要兩個部分：
- 一個yml配置文件用來進行配置
- 一個存放markdown文件的地址
在這里 mkdocs 生成了一個 docs 文件夾和 mkdocs.yml 配置文件
docs
mkdocs.yml
在這個路徑下執(zhí)行
mkdocs serve
可以通過 http://127.0.0.1:8000 訪問生成的網(wǎng)頁了溺健。
簡單配置
mkdocs會默認將 docs 文件夾下的 index.md 或者 readme.md 作為首頁。同時钮蛛，我們也可以通過自己的配置來決定頁面布局鞭缭。下面是一個完整的 mkdocs.yml
site_name: NAME
nav:
- Home: index.md
- About: about.md
- Other: other.md
theme:
name: readthedocs
- site_name 網(wǎng)頁的名字
- nav 導航欄
- theme 皮膚
