Documentation navigation

Essentials

Markdown Syntax

Document the baseline prose patterns supported by the template.

Headings

Use clear section headings so the right table of contents can expose the page structure.

Section titles create anchors that can be linked from the static TOC on the right side of the docs layout.

mdcmdc
## Titles

### Subtitles

Text Formatting

Markdown syntax can describe emphasis, inline code, and short UI labels while staying readable in source form.

Bold

**Bold**Bold

Italic

*Italic*Italic

Inline code

`pnpm dev`pnpm dev

Keyboard

:kbd{value="K"}K

Lists

Use ordered and unordered lists to explain installation steps, concepts, and API details.

  • Start with the goal of the page.
  • Group related setup steps together.
  • Link to follow-up pages instead of overloading one section.
mdcmdc
1. Install dependencies
2. Start the dev server
3. Open the docs route

Tables

Tables are useful for compact comparisons such as props, defaults, and supported variants.

PropDefaultType
name-string
sizemdstring
disabledfalseboolean

Blockquotes

Blockquotes help distinguish cited guidance or important prose from surrounding paragraphs.

Documentation should make the next action obvious without forcing readers to understand the whole system first.