Version: 2.0.0-beta.21

MDX and React

Using JSX in Markdown

Docusaurus has built-in support for MDX v1, which allows you to write JSX within your Markdown files and render them as React components.

note

While Docusaurus parses both .md and .mdx files using MDX, some of the syntaxes are treated slightly differently by third-party tools. For the most accurate parsing and better editor support, we recommend using the .mdx extension for files containing MDX syntax.

Check out the MDX docs to see what other fancy stuff you can do with MDX.

Exporting components

To define any custom component within an MDX file, you have to export it: only paragraphs that start with export will be parsed as components instead of prose.

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '2px',
      color: '#fff',
      padding: '0.2rem',
    }}>
    {children}
  </span>
);

<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.

I can write **Markdown** alongside my _JSX_!

Notice how it renders both the markup from your React component and the Markdown syntax:

http://localhost:3000

Docusaurus green and Facebook blue are my favorite colors.

I can write Markdown alongside my JSX!

MDX is JSX

Since all doc files are parsed using MDX, anything that looks like HTML is actually JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects.

/* Instead of this: */
<span style="background-color: red">Foo</span>
/* Use this: */
<span style={{backgroundColor: 'red'}}>Foo</span>

This behavior is different from Docusaurus 1. See also Migrating from v1 to v2.

In addition, MDX is not 100% compatible with CommonMark. Use the MDX playground to ensure that your syntax is valid MDX.

Importing components

You can also import your own components defined in other files or third-party components installed via npm.

<!-- Docusaurus theme component -->
import TOCInline from '@theme/TOCInline';
<!-- External component -->
import Button from '@mui/material/Button';
<!-- Custom component -->
import BrowserWindow from '@site/src/components/BrowserWindow';

tip

The @site alias points to your website's directory, usually where the docusaurus.config.js file is. Using an alias instead of relative paths ('../../src/components/BrowserWindow') saves you from updating import paths when moving files around, or when versioning docs and translating.

While declaring components within Markdown is very convenient for simple cases, it becomes hard to maintain because of limited editor support, risks of parsing errors, and low reusability. Use a separate .js file when your component involves complex JS logic:

src/components/Highlight.js
import React from 'react';

export default function Highlight({children, color}) {
  return (
    <span
      style={{
        backgroundColor: color,
        borderRadius: '2px',
        color: '#fff',
        padding: '0.2rem',
      }}>
      {children}
    </span>
  );
}

markdown-file.mdx
import Highlight from '@site/src/components/Highlight';

<Highlight color="#25c2a0">Docusaurus green</Highlight>

tip

If you use the same component across a lot of files, you don't need to import it everywhere—consider adding it to the global scope. See below

MDX component scope

Apart from importing a component and exporting a component, a third way to use a component in MDX is to register it to the global scope, which will make it automatically available in every MDX file, without any import statements.

For example, given this MDX file:

- a
- list!

And some <highlight>custom markup</highlight>...

It will be compiled to a React component containing ul, li, p, and highlight tags. Now, you can optionally provide your own implementation for any of these tags in the form of React components. (highlight isn't even an intrinsic element: it needs an implementation!)

In Docusaurus, this MDX component scope is provided by the @theme/MDXComponents component. It's not a React component, per se, unlike most other exports under the @theme/ alias: it is a record from tag names like ul and img to their custom implementations.

If you swizzle this component, you will find all tags that have been re-implemented, and you can further customize our implementation by swizzling the respective sub-component, like @theme/MDXComponents/Head (which is used to implement the <head> feature).

If you want to register extra tag names (like the <highlight> tag above), you should consider wrapping @theme/MDXComponents, so you don't have to maintain all the existing mappings. Since the swizzle CLI doesn't allow wrapping non-component files yet, you should manually create the wrapper:

src/theme/MDXComponents.js
import React from 'react';
// Import the original mapper
import MDXComponents from '@theme-original/MDXComponents';
import Highlight from '@site/src/components/Highlight';

export default {
  // Re-use the default mapping
  ...MDXComponents,
  // Map the "highlight" tag to our <Highlight /> component!
  // `Highlight` will receive all props that were passed to `highlight` in MDX
  highlight: Highlight,
};

And now, you can freely use <highlight> in every page, without writing the import statement:

I can conveniently use <highlight color="#25c2a0">Docusaurus green</highlight> everywhere!

http://localhost:3000

I can conveniently use Docusaurus green everywhere!

info

We use lower-case tag names like highlight to "pretend" that they are intrinsic elements, but you can use capitalized ones like Highlight as well.

Markdown and JSX interoperability

Docusaurus v2 is using MDX v1, which has a lot of known cases where the content fails to be correctly parsed as Markdown. Use the MDX playground to ensure that your syntax is valid MDX.

Samples of parsing failures

A paragraph starting with a JSX tag will be seen entirely as a JSX string:

Problem
Workaround

<span style={{color: 'red'}}>Highlighted text</span> but afterwards _Markdown_ **doesn't work**

http://localhost:3000

Highlighted text but afterwards _Markdown_ **doesn't work**

Use JSX for the rest of the line, or prefix the line with some plain text:

<span style={{color: 'red'}}>Use JSX for the paragraph</span> to stop <i>worrying about</i> <b>Markdown</b>

&#8203;<span style={{color: 'red'}}>← This is a zero-width space</span> and afterwards <i>Markdown</i> <b>works</b>

http://localhost:3000

Use JSX for the paragraph to stop worrying about Markdown

← This is a zero-width space and afterwards Markdown works

Markdown within a JSX tag never works:

Problem
Workaround

<span style={{color: 'red'}}>**Bold doesn't work**</span>

http://localhost:3000

**Bold doesn't work**

Use JSX within JSX tag, or move the Markdown to the outer layer:

<span style={{color: 'red'}}><b>Bold now works</b></span>

**<span style={{color: 'red'}}>Bold now works</span>**

http://localhost:3000

Bold now works

Text immediately below a JSX tag will be seen as JSX text:

Problem
Workaround

<div style={{color: 'red'}}>
**Bold still doesn't work**
</div>

http://localhost:3000

**Bold still doesn't work**

Add an empty new line:

<div style={{color: 'red'}}>

**Bold now works**

</div>

http://localhost:3000

Bold now works

Markdown text indented by four spaces will be seen as a code block:

Problem
Workaround

<div style={{color: 'red'}}>

    You may think I'm just some text...

</div>

http://localhost:3000

You may think I'm just some text...

Don't indent:

<div style={{color: 'red'}}>

Now I'm actually just text

</div>

http://localhost:3000

Now I'm actually just text

Importing code snippets

You can not only import a file containing a component definition, but also import any code file as raw text, and then insert it in a code block, thanks to Webpack raw-loader. In order to use raw-loader, you first need to install it in your project:

npm
Yarn

npm install --save raw-loader

yarn add raw-loader

Now you can import code snippets from another file as it is:

myMarkdownFile.mdx
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';

<CodeBlock language="jsx">{MyComponentSource}</CodeBlock>

http://localhost:3000

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import React, {useState} from 'react';

export default function MyComponent() {
  const [bool, setBool] = useState(false);
  return (
    <div>
      <p>MyComponent rendered !</p>
      <p>bool={bool ? 'true' : 'false'}</p>
      <p>
        <button onClick={() => setBool((b) => !b)}>toggle bool</button>
      </p>
    </div>
  );
}

See using code blocks in JSX for more details of the <CodeBlock> component.

note

You have to use <CodeBlock> rather than the Markdown triple-backtick ```, because the latter will ship out any of its content as-is, but you want to interpolate the imported text here.

warning

This feature is experimental and might be subject to breaking API changes in the future.

Importing Markdown

You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages.

By convention, using the _ filename prefix will not create any doc page and means the markdown file is a "partial", to be imported by other files.

_markdown-partial-example.mdx
<span>Hello {props.name}</span>

This is text some content from `_markdown-partial-example.mdx`.

someOtherDoc.mdx
import PartialExample from './_markdown-partial-example.mdx';

<PartialExample name="Sebastien" />;

http://localhost:3000

Hello Sebastien

This is text some content from _markdown-partial-example.md.

This way, you can reuse content among multiple pages and avoid duplicating materials.

caution

Currently, the table of contents does not contain the imported Markdown headings. This is a technical limitation that we are trying to solve (issue).

Available exports

Within the MDX page, the following variables are available as globals:

frontMatter: the front matter as a record of string keys and values;
toc: the table of contents, as a tree of headings. See also Inline TOC for a more concrete use-case.
contentTitle: the Markdown title, which is the first h1 heading in the Markdown text. It's undefined if there isn't one (e.g. title specified in the front matter).

import TOCInline from '@theme/TOCInline';
import CodeBlock from '@theme/CodeBlock';

The table of contents for this page, serialized:

<CodeBlock className="language-json">{JSON.stringify(toc, null, 2)}</CodeBlock>

The front matter of this page:

<ul>
  {Object.entries(frontMatter).map(([key, value]) => <li key={key}><b>{key}</b>: {value}</li>)}
</ul>

<p>The title of this page is: <b>{contentTitle}</b></p>

http://localhost:3000

The table of contents for this page, serialized:

[
  {
    "value": "Using JSX in Markdown",
    "id": "using-jsx-in-markdown",
    "level": 2
  },
  {
    "value": "Exporting components",
    "id": "exporting-components",
    "level": 3
  },
  {
    "value": "Importing components",
    "id": "importing-components",
    "level": 3
  },
  {
    "value": "MDX component scope",
    "id": "mdx-component-scope",
    "level": 3
  },
  {
    "value": "Markdown and JSX interoperability",
    "id": "markdown-and-jsx-interoperability",
    "level": 3
  },
  {
    "value": "Importing code snippets",
    "id": "importing-code-snippets",
    "level": 2
  },
  {
    "value": "Importing Markdown",
    "id": "importing-markdown",
    "level": 2
  },
  {
    "value": "Available exports",
    "id": "available-exports",
    "level": 2
  }
]

The front matter of this page:

id: react
title: MDX and React
description: Using the power of React in Docusaurus Markdown documents, thanks to MDX
slug: /markdown-features/react

The title of this page is: MDX and React

MDX and React

Using JSX in Markdown​

note

Exporting components​

MDX is JSX

Importing components​

tip

tip

MDX component scope​

info

Markdown and JSX interoperability​

Importing code snippets​

note

warning

Importing Markdown​

caution

Available exports​

Using JSX in Markdown

Exporting components

Importing components

MDX component scope

Markdown and JSX interoperability

Importing code snippets

Importing Markdown

Available exports