Docusaurus Markdown: Complete Guide
Docusaurus is a static site generator by Meta designed for documentation websites. It uses markdown and MDX (markdown with JSX) for content, supports versioned docs, internationalization, and lets you embed React components directly in your markdown files.
Markdown support:GFM
Markdown Support in Docusaurus
| 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] | No Not supported by default; requires a plugin |
| Horizontal Rule | --- | Yes |
Things to know
- Supports MDX, allowing React components inside markdown files.
- Front matter in markdown files controls page metadata and sidebar positioning.
- Admonitions use :::note, :::tip, :::warning syntax.
- Built-in support for versioned documentation and i18n.
Frequently Asked Questions
Does Docusaurus support markdown?
Yes. Docusaurus supports GFM and MDX (markdown with embedded JSX). You can write standard markdown and also use React components directly in your content files.
How do you bold text in Docusaurus?
Use standard markdown syntax: **bold text**. Docusaurus processes your markdown files and renders them as part of your documentation site.
What is MDX in Docusaurus?
MDX lets you use JSX (React components) inside markdown files. This means you can embed interactive elements, custom components, and dynamic content alongside your markdown text.
Is Docusaurus free?
Yes. Docusaurus is free and open source, maintained by Meta. It is widely used for documentation sites of open-source projects.