良品杂货铺

MkDocs

基于 Python 语言和 Markdown 语法自动生成静态网页文档的工具。安装非常简单,只需一行命令:

1
pip install mkdocs

创建文档也很容易:

1
2
3
mkdocs new my-project
cd my-project
mkdocs serve

访问 http://127.0.0.1:8000 就可以看到效果。MkDocs 生成的静态网页也可以很容易地发布到 Github Project PageAmazon S3 等站点上。

MkDocs 的主要用法在 MkDocs 主页 上几乎一页就描述完毕。