MkDocs 是一个静态站点生成器,专为构建文档网站而设计。MkDocs 是用 Python 编程语言编写的,是一个开源项目,提供了很多社区支持。有多种主题可供选择。在 Markdown 支持方面,MkDocs 在支持基本语法元素方面做得非常出色,但它缺乏对一些扩展语法元素的支持。

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

A newly deployed MkDocs site.

MkDocs Markdown 支持

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

Element Support Notes
Headings Yes
Paragraphs Yes
Line Breaks Yes
Bold Yes
Italic Yes
Blockquotes Yes
Ordered Lists Yes
Unordered Lists Yes
Code Yes
Horizontal Rules Yes
Links Yes
Images Yes
Tables Yes
Fenced Code Blocks Yes
Syntax Highlighting Yes
Footnotes No
Heading IDs No
Definition Lists No
Strikethrough No
Task Lists No
Emoji (copy and paste) Unknown
Emoji (shortcodes) Unknown
Highlight No
Subscript No
Superscript No
Automatic URL Linking Yes
Disabling Automatic URL Linking Yes
HTML Yes

使用声明

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

另请参阅

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

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

获取书籍