mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器,中文文档地址
使用 mkdocs 我们可以用 md 编写自己的文档,而且可以免费部署到 GitHub 。
安装
pip install mkdocs
新建文档
λ mkdocs.exe new mydoc
INFO - Creating project directory: mydoc
INFO - Writing config file: mydoc\mkdocs.yml
INFO - Writing initial docs: mydoc\docs\index.md
λ cd mydoc\
d:\code\mydoc
λ ls
docs/ mkdocs.yml
d:\code\mydoc
λ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 190528 20:32:49 server:296] Serving on http://127.0.0.1:8000
[I 190528 20:32:49 handlers:62] Start watching changes
[I 190528 20:32:49 handlers:64] Start detecting changes
[I 190528 20:33:06 handlers:135] Browser Connected: http://127.0.0.1:8000/
编辑文档
vi docs/index.md
把 command 改为中文 命令 记得把文件改为 utf8 编码,否则会出错
INFO - Building documentation...
ERROR - Encoding error reading file: index.md
ERROR - Error reading page 'index.md': 'utf-8' codec can't decode byte 0xc3 in position 92: invalid continuation byte
[