Essentials

Markdown Syntax

Text, titles and styling in standard markdown.

Documents are markdown with MDC syntax on top, so components can be used without importing anything.

Titles

Use titles to introduce main sections. They structure your documentation and help readers navigate.

## Titles
### Subtitles

Headings become anchors automatically and populate the table of contents.

Text Formatting

StyleSyntaxOutput
Bold**bold**bold
Italic_italic_italic
Strikethrough~~struck~~struck
Inline code`code`code
Link[label](/docs)label

Styled spans use MDC's bracket syntax — [emphasis]{.text-primary} renders as emphasis, and keyboard keys use :kbd{value="K"}: press Ctrl K to open search.

Internal links are routed on the client, external links open in a new tab:

Lists

Unordered

  • First item
  • Second item
  • Third item

Ordered

  1. First step
  2. Second step
  3. Third step

Nested

  • Parent item
    • Child item
    • Another child
  • Second parent

Task lists

  • Content pipeline
  • MDC syntax
  • Search

Tables

ConventionEffect
1. prefixSets sidebar order
.navigation.ymlSets a section title and icon
navigation: falseHides a page from the sidebar

Blockquotes

Singleline

Content is just files on disk.

Multiline

Every route comes from a file under content/.

Adding an .mdx file creates the route and the sidebar entry.