Skip to Content
🚧 This is WIP documentation for Nextra 4.0

Markdown

MDX

With Nextra, all your .mdx files under the pages directory will be rendered with MDX , it’s an advanced Markdown format with React component support.

For example, you can use import and use React components inside your MDX files like this:

MDX
## Hello MDX import { useState } from 'react' export function Counter({ children }) { const [count, setCount] = useState(0) return ( <button onClick={() => setCount(prev => prev + 1)}> {children} {count} </button> ) } <Counter>**Clicks**: </Counter>

Generates:

Besides basic MDX, Nextra also has some advanced Markdown features built-in.

GitHub Flavored Markdown

GFM  is an extension of Markdown, created by GitHub, that adds support for strikethrough, task lists, tables, and more.

Strikethrough

removed

Markdown
~~removed~~

Task List

  • Write the press release
  • Update the website
  • Contact the media
Markdown
- [x] Write the press release - [ ] Update the website - [ ] Contact the media

Table

SyntaxDescriptionTest Text
HeaderTitleHere’s this
ParagraphTextAnd more
StrikethroughText
Markdown
| Syntax | Description | Test Text | | :------------ | :---------: | ----------: | | Header | Title | Here's this | | Paragraph | Text | And more | | Strikethrough | | ~~Text~~ |

Visit https://nextjs.org .

Visit https://nextjs.org.

Custom Heading ID

You can specify custom heading id using the format ## My heading [#custom-id]. For example:

Markdown
## Long heading about Nextra [#about-nextra]

In this example, #about-nextra will be used as the heading link, replacing the default #long-heading-about-nextra.

Last updated on