Docusaurus is an open-source static site generator that converts Markdown files to a documentation website. Created by Facebook, Docusaurus is written in the Node.js programming language. Thousands of organizations use Docusaurus to power their documentation websites. An example of a website generated by Docusaurus is shown below.
Docusaurus uses the remarkable Markdown processor.
Docusaurus Markdown Support
Docusaurus provides support for the following Markdown elements.
| Element | Support | Notes |
|---|---|---|
| Headings | Yes | |
| Paragraphs | Yes | |
| Line Breaks | Yes | You can use a trailing backslash (\) instead of trailing whitespace.
|
| 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 | Yes | |
| Heading IDs | Partial | Automatically generated. There’s no way to set custom heading IDs. |
| Definition Lists | No | |
| Strikethrough | Yes | |
| 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 |
See Also
Take your Markdown skills to the next level.
Learn Markdown in 60 pages. Designed for both novices and experts, The Markdown Guide book is a comprehensive reference that has everything you need to get started and master Markdown syntax.
Get the BookWant to learn more Markdown?
Don't stop now! 🚀 Star the GitHub repository and then enter your email address below to receive new Markdown tutorials via email. No spam!