MkDocs Markdown: Complete Guide
MkDocs is a fast, simple static site generator built for project documentation. It uses markdown files as source content and generates a clean, responsive documentation site. The popular Material for MkDocs theme adds many extensions including admonitions, tabs, and content annotations.
Markdown support:Full
Markdown Support in MkDocs
| Format | Syntax | Support |
|---|---|---|
| Bold | **text** | Yes |
| Italic | *text* | Yes |
| Strikethrough | ~~text~~ | Yes |
| Headings | # H1 ... ###### H6 | Yes |
| Links | [text](url) | Yes |
| Images |  | Yes |
| Blockquotes | > quote | Yes |
| Ordered Lists | 1. item | Yes |
| Unordered Lists | - item | Yes |
| Code (inline) | `code` | Yes |
| Code Blocks | ```lang\ncode\n``` | Yes |
| Tables | | col | col | | Yes |
| Task Lists | - [ ] task | Yes |
| Footnotes | [^1] | Yes Via pymdownx.footnote extension |
| Horizontal Rule | --- | Yes |
Things to know
- Configuration is done via a mkdocs.yml file in the project root.
- The Material theme adds many markdown extensions beyond standard MkDocs.
- Supports admonitions (callouts) with !!! note, !!! warning syntax.
- Live reload during development with mkdocs serve.
Frequently Asked Questions
Does MkDocs support markdown?
Yes. MkDocs uses markdown as its primary content format. It supports CommonMark plus extensions through Python-Markdown. The Material theme adds even more extensions like admonitions, tabs, and annotations.
How do you bold text in MkDocs?
Use standard markdown syntax: **bold text**. MkDocs processes your markdown files and renders them as HTML in the generated documentation site.
What is Material for MkDocs?
Material for MkDocs is a popular theme that adds a modern design and many markdown extensions including admonitions, content tabs, annotations, code copy buttons, and search improvements.
Is MkDocs free?
Yes. MkDocs is free and open source. The Material theme offers both a free community edition and a paid Insiders edition with additional features.