Docusaurus
Docusaurus is a tool developed by Facebook that allows you to create static websites based on Markdown documents.
Overview
Docusaurus is a powerful program, simple to use and very popular with organizations.
Node.js was the development pillar chosen by the team of programmers to develop Docusaurus.
Users of the tool typically use Docusaurus to create online documentation for various products, from programs to frameworks.
The Markdown processor used by the application is the remarkable.
The official Docusaurus website is https://docusaurus.io/.
Docusaurus Markdown Support
Table 1.1 shows the Markdown elements compatible with Docusaurus.
| Element | Support | Information |
|---|---|---|
| Titles | Yes | |
| Paragraphs | Yes | |
| Line breaks | Yes | The tool supports the use of a backslash \ at the end of the line to insert a line break. The backslash can replace the use of white spaces. |
| Bold | Yes | |
| Italic | Yes | |
| Blockquote | Yes | |
| Ordered lists | Yes | |
| Unordered lists | Yes | |
| Code | Yes | |
| Horizontal lines | Yes | |
| Links | Yes | |
| Images | Yes | |
| Tables | Yes | |
| Fenced code blocks | Yes | Highlighting the syntax of the programming language used in the code block is also possible. |
| Footnotes | Yes | |
| Title Id | Partial | It is automatically generated by Docusaurus, there is no way for the user to customize the ids. |
| Definition lists | No | |
| Strikethrough | Yes | |
| Task lists | No | |
| Emoji (copy and paste) | Unknown | |
| Emoji (access codes) | Unknown | |
| automatic URL Link | Yes | |
| Disable automatic link from URL | Yes | |
| HTML | Yes |