mkdocs

MK文档

使用 Markdown 编写项目文档

MkDocs 是一个快速、简单且华丽的静态站点生成器，适用于构建项目文档。文档源文件是用 Markdown 编写的，并使用单个 YAML 配置文件进行配置。它的设计易于使用，并且可以通过第三方主题、插件和 Markdown 扩展进行扩展。

请参阅文档以获取介绍性教程和完整的用户指南。

特征

• 从 Markdown 文件构建静态 HTML 文件。
• 使用插件和 Markdown 扩展来增强 MkDocs。
• 使用内置主题、第三方主题或创建您自己的主题。
• 在可以提供静态文件的任何地方发布您的文档。
• 还有更多！

支持

如果您需要 MkDocs 方面的帮助，请随时与我们联系！

• 对于问题和高级讨论，请使用 GitHub 上的讨论。
  • 对于小问题，Gitter/Matrix 上的聊天室是一个不错的选择。
• 要报告错误或提出功能请求，请在 GitHub 上打开问题。

请注意，我们可能只为有关 MkDocs 核心功能的问题提供支持。有关第三方主题、插件、扩展或类似功能的任何问题或错误报告应针对其各自的项目进行。
但是，聊天室并没有禁止此类问题。

请务必留下来回答一些问题！

链接

• 官方文档
• 最新发行说明
• 第三方插件、主题和配方目录

为 MkDocs 做出贡献

MkDocs 项目欢迎并依赖开源社区中的开发人员和用户的贡献。请参阅贡献指南以获取有关如何提供帮助的信息。

行为守则

在 MkDocs 项目的代码库、问题跟踪器和讨论论坛中进行交互的每个人都应遵循 PyPA 行为准则。

执照

BSD-2 条款