# MkDocs

MkDocs

MkDocs (opens new window) 是一个专为构建文档网站而设计的静态站点生成器。其使用 Python 编写,是一个拥有大量社区支持的开源项目。提供了多种可用的主题 (opens new window)。在 Markdown 支持方面,MkDocs 对基本语法元素的支持非常出色,但缺少一些扩展语法元素的支持。

该应用使用 Python-Markdown (opens new window) 作为 Markdown 处理器。你可以启用额外的扩展 (opens new window)。

新部署的 MkDocs 网站

# MkDocs Markdown 支持

MkDocs 支持以下 Markdown 元素。

功能 支持 备注
标题 是
段落 是
换行 是
粗体 是
斜体 是
引用块 是
有序列表 是
无序列表 是
代码 是
水平线 是
链接 是
图片 是
表格 是
围栏代码块 是
语法高亮 是
脚注 否
标题 ID 否
定义列表 否
删除线 否
任务列表 否
表情符号(复制粘贴) 未知
表情符号(短代码) 未知
高亮 否
下标 否
上标 否
自动 URL 链接 是
禁用自动 URL 链接 是
HTML 是

# 使用警告

这是一个实用的功能:你可以启用一个扩展来在 MkDocs 中使用警告 (opens new window)。这是一种在 MkDocs 网站上快速使用备注、警告和提示的方式。有关更多信息和示例,请参见此 GitHub 问题 (opens new window)。

# 另见



微信公众号

QQ交流群
原创网站开发,偏差难以避免。

如若发现错误,诚心感谢反馈。

愿你倾心相念,愿你学有所成。

愿你朝华相顾,愿你前程似锦。