Skip to main content

Markdown Features

Docusaurus supports the Markdown syntax and has some additional features.

Front Matter#

Markdown documents can have associated metadata at the top called Front Matter:

id: my-doc
title: My document title
description: My document description
sidebar_label: My doc
Markdown content

Markdown 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](./

Let's see how to Create a page.

Markdown images#

Regular Markdown images are supported.

Add an image at static/img/docusaurus.png and use this Markdown declaration:

![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

React components#

Thanks to MDX, you can make your doc more interactive and use React components inside Markdown:

export const Highlight = ({children, color}) => (
backgroundColor: color,
borderRadius: '2px',
color: 'red',
padding: '0.2rem',
<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.
Docusaurus green and Facebook blue are my favorite colors.