Skip to main content

Markdown Features

· 2 min read
Lex
Lex
Front End Engineer @ Baoxiaohe

Docusaurus supports Markdown and a few additional features.

Front Matter#

Markdown documents have metadata at the top called Front Matter:

my-doc.md
---id: my-doc-idtitle: My document titledescription: My document descriptionslug: /my-custom-url---
## Markdown heading
Markdown text with [links](./hello.md)

Links#

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

Let's see how to [Test](../docs/react-basics/first-react-demo.md).
Let's see how to [Test](../docs/react-basics/first-react-demo.md).

Images#

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>    )}```
src/components/HelloDocusaurus.js
function HelloDocusaurus() {  return <h1>Hello, Docusaurus!</h1>;}

Admonitions#

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

This is Docusaurus green !

This is Facebook blue !

Congratulations!#

You have just learned the basics of Docusaurus and made some changes to the initial template.

Docusaurus has much more to offer!

Have 5 more minutes? Take a look at versioning and i18n.

Anything unclear or buggy in this tutorial? Please report it!

What's next?#