MkDocs¶

Markdown 的项目文档。

MkDocs 是一个快速，简单和 华丽的 静态站点生成器，用于构建项目文档。文档源文件用 Markdown 编写，并使用单个 YAML 配置文件进行配置。首先阅读入门教程，然后查看用户指南以获得更多信息。

特征

很棒的主题

There's a stack of good looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the third-party themes listed on the MkDocs Themes wiki page, or build your own.

易于自定义

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.