MkDocs 是一款静态网站生成器,专为构建文档网站而设计。MkDocs 使用 Python 编程语言编写,是一个拥有大量社区支持的开源项目。提供各种 主题。在 Markdown 支持方面,MkDocs 在支持基本语法元素方面做得很好,但它缺少对某些扩展语法元素的支持。

该应用程序使用 Python-Markdown Markdown 处理器。您可以启用其他 扩展

A newly deployed MkDocs site.

MkDocs Markdown 支持

MkDocs 为以下 Markdown 元素提供支持。

元素 支持 说明
标题
段落
换行符
粗体
斜体
引用块
有序列表
无序列表
代码
水平规则
链接
图像
表格
带围栏的代码块
语法高亮
脚注
标题 ID
定义列表
删除线
任务列表
表情符号(复制粘贴) 未知
表情符号(简码) 未知
高亮
下标
上标
自动 URL 链接
禁用自动 URL 链接
HTML

使用警告

这是一个便捷的功能:您可以在 MkDocs 中启用一个扩展来使用 警告。这是一种在 MkDocs 网站上快速轻松地开始使用注释、警告和提示的方法。有关更多信息和示例,请参阅此 GitHub 问题

另请参阅

将您的 Markdown 技能提升到一个新的水平。

在 60 页中学习 Markdown。Markdown 指南 一书专为新手和专家设计,是一本综合参考,包含入门和掌握 Markdown 语法所需的一切内容。

获取本书
想了解更多 Markdown 知识吗?

不要现在就停止!🚀 为 GitHub 存储库 加星标,然后在下面输入您的电子邮件地址,以通过电子邮件接收新的 Markdown 教程。无垃圾邮件!