MkDocs

使用Markdown管理项目文档。


MkDocs是一套快速简单功能强大,面向构建项目文档的静态网站生成器。文档的源文件使用Markdown编写, 使用单一YAML配置文件来完成站点的配置。从阅读入门教程开始,然后检查用户指南获取更多信息。

特性

强大的主题功能

MkDocs有很多好看的主题可供选择。你可以从MkDocs内置的两个主题mkdocsreadthedocs)中选一个, 也可从MKDocs主题wiki页中选则一个第三方的主题,甚至你可以自己定制一个自己的主题。

定制简单

Get your project documentation looking just the way you want it by customizing your theme and/or installing some plugins. Modify Markdown's behavior with Markdown extensions. Many configuration options are available.

编写的同时可以预览

The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.

在任何位置托管

MkDocs builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.