MkDocs

使用 Markdown 的项目文档。

MkDocs 是一个快速、简单且非常漂亮的静态网站生成器，旨在用于构建项目文档。文档源文件是用 Markdown 编写的，并通过单个 YAML 配置文件进行配置。从阅读 入门教程 开始，然后查看 用户指南 以获取更多信息。

入门 用户指南

特点

提供出色的主题

MkDocs 提供了一系列外观漂亮的 主题。可以选择内置主题：mkdocs 和 readthedocs，选择其中一个第三方主题（在 MkDocs 主题 Wiki 页面以及 MkDocs 目录 中），或者 自己构建。

易于自定义

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

边写边预览网站

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

随处托管

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