Skip to main content
Version: 2.0.0-alpha.74

Headings

Markdown headings#

You can use regular Markdown headings.

## Level 2 title
### Level 3 title
#### Level 4 title

Markdown headings appear as a table-of-contents entry.

Heading ids#

Each heading has an id that can be automatically generated, or explicitly specified.

Heading ids allow you to link to a specific document heading in Markdown or JSX:

[link](#heading-id)
<Link to="#heading-id">link</Link>

Generated ids#

By default, Docusaurus will generate heading ids for you, based on the heading text.

### Hello World will have id hello-world.

Generated ids have some limits:

  • The id might not look good
  • You might want to change or translate the text without updating the existing id

Explicit ids#

A special Markdown syntax lets you set an explicit heading id:

### Hello World {#my-explicit-id}
tip

Use the write-heading-ids CLI command to add explicit ids to all your Markdown documents.

Last updated on by Sébastien Lorber