Documentation

Writing docs

Add and maintain Markdown files for the documentation navigation.

Supported Markdown

Fumadocs compiles Markdown and MDX with a documentation-focused preset.

  • Headings
  • Paragraphs and lists
  • Tables
  • Code blocks
  • Links and images
  • MDX components when a file uses .mdx

The sidebar is generated from meta.json and files in the active locale. A document is available at /docs/{slug} where {slug} is the filename without .md.

Markdown can use normal links to jump between documentation pages:

[Back to introduction](/docs)
[View deployment notes](/docs/deployment)

The rendered page keeps the active language, so an English page links to /en/docs/deployment.