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 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 | Yes | |
Definition Lists | No | |
Strikethrough | Yes | |
Task Lists | Yes | |
Emoji (copy and paste) | Yes | |
Emoji (shortcodes) | Yes | |
Highlight | No | |
Subscript | No | |
Superscript | No | |
Automatic URL Linking | Yes | |
Disabling Automatic URL Linking | Yes | |
HTML | Yes |