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
### SubtitlesHeadings become anchors automatically and populate the table of contents.
Text Formatting
| Style | Syntax | Output |
|---|---|---|
| Bold | **bold** | bold |
| Italic | _italic_ | italic |
| Strikethrough | ~~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.
Links
Internal links are routed on the client, external links open in a new tab:
Lists
Unordered
- First item
- Second item
- Third item
Ordered
- First step
- Second step
- Third step
Nested
- Parent item
- Child item
- Another child
- Second parent
Task lists
- Content pipeline
- MDC syntax
- Search
Tables
| Convention | Effect |
|---|---|
1. prefix | Sets sidebar order |
.navigation.yml | Sets a section title and icon |
navigation: false | Hides a page from the sidebar |
Blockquotes
Singleline
Content is just files on disk.
Multiline
Every route comes from a file under
content/.Adding an
.mdxfile creates the route and the sidebar entry.