跳转到主要内容

使用Markdown的项目文档。

项目描述

MkDocs

使用 Markdown 的项目文档

PyPI Version Build Status Coverage Status

MkDocs 是一个 快速简单非常漂亮 的静态网站生成器,专门用于构建项目文档。文档源文件使用 Markdown 编写,并使用单个 YAML 配置文件进行配置。它设计得非常易于使用,可以通过第三方主题、插件和 Markdown 扩展进行扩展。

请参阅文档以获取入门教程和完整用户指南。

功能

  • 从 Markdown 文件生成静态 HTML 文件。
  • 使用插件和 Markdown 扩展增强 MkDocs。
  • 使用内置主题、第三方主题或创建自己的主题。
  • 在任何可以提供静态文件的服务器上发布您的文档。
  • 更多功能!

支持

如果您需要关于 MkDocs 的帮助,请不要犹豫,与我们取得联系!

  • 对于问题和高级讨论,请使用 GitHub 上的 讨论区
    • 对于小问题,Gitter/Matrix 上的 聊天室 是一个好的替代方案。
  • 要报告错误或提出功能请求,请打开 GitHub 上的 问题

请注意,我们可能只为 MkDocs 核心功能的问题/问题提供支持。有关第三方主题、插件、扩展或其他类似功能的任何问题或错误报告,应提交给相应项目。
但,此类问题 不会被禁止聊天室 中。

请确保留下来回答一些问题!

链接

为 MkDocs 做贡献

MkDocs 项目欢迎并依赖开源社区的贡献。请参阅贡献指南了解如何帮助。

行为准则

所有与 MkDocs 项目的代码库、问题跟踪器和讨论论坛互动的人都应遵守 PyPA 行为准则

许可

BSD-2-Clause

项目详情


发行历史 发布通知 | RSS 源

下载文件

下载适用于您的平台文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

mkdocs-1.6.1.tar.gz (3.9 MB 查看散列值)

上传时间

构建分发

mkdocs-1.6.1-py3-none-any.whl (3.9 MB 查看散列值)

上传时间 Python 3

支持者