MkDocs

使用 Markdown 编写项目文档。

MkDocs 是一个 快速、简单 且 极其美观 的静态网站生成器，专为构建项目文档而设计。文档源文件使用 Markdown 编写，并通过单一的 YAML 配置文件进行配置。首先阅读 入门教程，然后查看 用户指南 获取更多信息。

开始使用 用户指南

功能

丰富的主题选择

MkDocs 提供了许多美观的 主题。你可以选择内置的主题： mkdocs 和 readthedocs， 或者从第三方主题中挑选 （在 MkDocs 主题 维基页面 以及 MkDocs 目录 中）， 甚至可以 自己构建 一个主题。

易于定制

通过 自定义主题 和/或安装一些 插件，让你的项目文档看起来完全符合你的要求。使用 Markdown 扩展 修改 Markdown 的行为。许多 配置选项 可供选择。

实时预览你的工作

内置的开发服务器允许你在编写文档时实时预览。它甚至会在你保存更改时自动重新加载并刷新浏览器。

随处托管

MkDocs 生成完全静态的 HTML 网站，你可以将其托管在 GitHub Pages、Amazon S3 或 其他任何地方。