mkdocs

[fengzhao]

MKDocs

• python 编写的 markdown 解释器、编译器，带有本地cli工具；
• 自带基于Tornado的小型 http 服务，用于本地调试；
• 内置一键式发布至GitHub Pages；
• 内置mkdocs风格、readthedocs 风格的主题，并支持自定义主题；
• 支持调用python模块实现语法及渲染的扩展；

官网 https://www.mkdocs.org/

主题 <https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes

mkdocs-material

• 符合 google material ui 规范的静态文档网站生成器，使用 markdown 进行文档书写;

• 针对特定语法、功能做了渲染优化；

• 根据客户端浏览器页面尺寸自动缩放，对PC、移动设备都友好；

• 丰富的页面配色，多达19种主体配色和16种悬停链接文字配色；

• 支持中文搜索；

• 支持统计功能，如百度统计，谷歌统计；

# 安装
pip install mkdocs-material
pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-material

# 会自动安装相关依赖， mkdocs,markdown,

mkdocs new my-project