Mkdocs 是一个采用 Python 构建轻量级的静态 HTML 在线文档框架,内置部署到 Github Pages 的功能。我用来创建实践指南,用来做个人的知识积累。
安装 Mkdocs 以及 Mkdocs 主题
Mkdocs 以及主题都通过pip
安装,例如我采用的mkdocs-material主题,如下所示:
pip install --user mkdocs mkdocs-material
值得一说的是,如果你安装主题,mkdocs 会作为依赖被安装。
更多的主题请参考 Wiki 页:https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
创建并测试站点
通过mkdocs new <目录>
就可以快速创建文档站点。目录里会生成