LogoLogo
GitHub repository
GitHub repository
    Documentation
  • Overview
  • Getting Started
  • Guides


    • Styling, CSS-in-JS, and Joy UI
    • Using MDX
    • Advanced Concepts
  • Hooks

  • Components

Using MDX

Support for MDX is built-in. You can use it to build React components and pages with Markdown. For an example, read this page's source code in src/app/(main)/guides/using-mdx/page.mdx.

Basics

Italic, bold, strikethrough.

Headings

h3

h4

h5
h6
IDs are also supported (and will be picked up by the PageOverview component)

Images

Logo image
You can also scale the image (recommended as this reduces cumulative layout shifts):
Logo image Logo image

Custom components

Quotes

This is a blockquote.
Multi-line is supported
Nested blockquote

Footnote

A note1

Table

abcd
Thisisatable
demonstratingvariousalignmentoptions.

Lists

  • You can make
  • normal lists
    • And indent them like this
  1. Or you can make
  2. numbered lists
    1. And indent them like this
  • Or you can make
  • task lists
    • Again, indented like this
  • Update website www.example.com

Code

Use single backticks for inline code.
Normal code blocks
Normal code blocks
const code = 'syntax highlighting code blocks';
const code = 'syntax highlighting code blocks';
1const code = 'code block with line numbers';
2if (code) {
3 return "and multiple lines, too";
4}
1const code = 'code block with line numbers';
2if (code) {
3 return "and multiple lines, too";
4}

Dividers

Horizontal dividers

Math

You can write math like a2+b2\sqrt{a^2 + b^2}
Or you can do 123123

Footnotes

  1. Big note.

LogoLogo