MkDocs

MkDocs 是一个基于Python的静态站点生成器,整合了Markdown和Jinja2来生成静态网页。源代码参见source code is available on GitHub

MkDocs static site and documentation generator logo.

MkDocs有什么优点?

MkDocs使用YAML配置文件,可以使用主题方便的更改输出文档的外观。

除了YAML配置文件和可变主题,MkDocs还有一个搜索特性。在其他静态站点生成器里搜索不太容易,但是在MkDocs里可以容易添加搜索而无需插件或修改代码。

MkDocs资源

  • The official Getting Started with MkDocs is likely the best place to go when you are just getting set up with your first site that uses this project.
  • Building Markdown-based Sites with MkDocs provides an initial perspective on using MkDocs to build a static website along with some of the advantages and disadvantages that come with using this static site generator.
  • Mkdocs documentation is a quick tutorial to get MkDocs installed and modify the initial mkdocs.yml file.
  • MkDocs making strides is a post from one of the project’s core commiters on some changes that greatly improved the project such as site regeneration during development when a file is modified, search, the command-line client and packageable theming.