Skip to main content

Markdown syntax

Use headings, paragraphs, links, lists and fenced code blocks to structure your docs. Give each page a title and description in frontmatter. In Fumadocs, start body headings at H2 because the template already displays the page title.

  • Link to real pages, such as [Quickstart](/docs/quickstart) when that page exists.
  • Add a language label to fenced code blocks for syntax highlighting.
  • Give images useful alt text and check them on mobile.
  • Use concise tables for comparisons; wide tables should remain readable on small screens.

MDX also supports imported React components. The available components depend on the site's template. New projects use Fumadocs; existing Docusaurus projects may use different imports and syntax.

See frontmatter, components and navigation.