Skip to main content

Markdown Features

Docusaurus supports Markdown and a few additional features.

Front Matter#

Markdown documents have metadata at the top called Front Matter:
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
## Markdown heading
Markdown text with [links](./


Regular Markdown links are supported, using url paths or relative file paths.

Let's see how to [Create a page](/create-a-page).
Let's see how to [Create a page](./

Result: Let's see how to Create a page.


Regular Markdown images are supported.

Add an image at static/img/docusaurus.png and display it in Markdown:

![Docusaurus logo](/img/docusaurus.png)

Docusaurus logo

Code Blocks#

Markdown code blocks are supported with Syntax highlighting.

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return (
<h1>Hello, Docusaurus!</h1>
function HelloDocusaurus() {
return <h1>Hello, Docusaurus!</h1>;


Docusaurus has a special syntax to create admonitions and callouts:

:::tip My tip
Use this awesome feature option
:::danger Take care
This action is dangerous
My tip

Use this awesome feature option

Take care

This action is dangerous

MDX and React Components#

MDX can make your documentation more interactive and allows using any React components inside Markdown:

export const Highlight = ({children, color}) => (
backgroundColor: color,
borderRadius: '20px',
color: '#fff',
padding: '10px',
cursor: 'pointer',
onClick={() => {
alert(`You clicked the color ${color} with label ${children}`)
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
This is <Highlight color="#1877F2">Facebook blue</Highlight> !

This is Docusaurus green !

This is Facebook blue !