MkDocs is a static site generator designed for building documentation websites. Written in the Python programming language, MkDocs is an open-source project with a lot of community support. A variety of themes are available. In terms of Markdown support, MkDocs does an excellent job supporting the basic syntax elements, but it lacks support for some extended syntax elements.

A newly deployed MkDocs site.

MkDocs Markdown Support

MkDocs provides support for the following Markdown elements. The application uses the Python-Markdown Markdown processor. You can enable additional extensions.

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 is supported.
Footnotes No
Heading IDs No
Definition Lists No
Strikethrough No
Task Lists No
Automatic URL Linking Yes
Disabling Automatic URL Linking Yes
HTML Yes

Using Admonitions

Here’s a handy feature: You can enable an extension to use admonitions in MkDocs. This is a quick and easy way to start using notes, warnings, and tips on your MkDocs site. See this GitHub issue for more information and examples.

See Also

Markdown Guide book cover
Take your Markdown skills to the next level.

Learn everything you need to know about Markdown. The Markdown Guide book includes information on getting started, choosing a Markdown application, using basic and extended syntax, and more.

Get the book
Want to learn more Markdown?

Don't stop now! 😎 Star the GitHub repository and drop in to the Slack chat room. If you liked this and want to receive new Markdown tutorials, enter your email address below. No spam!