Markdown Features
Docusaurus supports Markdown and a few additional features.
#
Front MatterMarkdown documents have metadata at the top called Front Matter:
my-doc.md
#
LinksRegular Markdown links are supported, using url paths or relative file paths.
Result: Let's see how to Create a page.
#
ImagesRegular Markdown images are supported.
Add an image at static/img/logo.svg
and display it in Markdown:
#
Code BlocksMarkdown code blocks are supported with Syntax highlighting.
src/components/HelloDocusaurus.js
#
AdmonitionsDocusaurus has a special syntax to create admonitions and callouts:
My tip
Use this awesome feature option
Take care
This action is dangerous
#
MDX and React ComponentsMDX can make your documentation more interactive and allows using any React components inside Markdown:
This is Docusaurus green !
This is Facebook blue !