• English
  • MDX & React components

    Rspress supports not only Markdown but also MDX, a powerful way to develop content.

    Markdown

    MDX is a superset of Markdown, which means you can write Markdown files as usual. For example:

    # Hello world

    Use components

    When you want to use React components in Markdown files, you should name your files with .mdx extension.

    // docs/index.mdx
    import { CustomComponent } from './custom';
    
    # Hello world
    
    <CustomComponent />

    Use Rspress built-in components

    foo.js
    bar.js
    console.log('foo');