Markdown Syntax
Every .md file under content/docs/ is a page. Write the body in standard Markdown and reach for MDC components when you need richer layouts.
Headings
The page title comes from the title frontmatter field, so the body starts at level two:
## Second-level heading
### Third-level heading
- Second- and third-level headings get anchors automatically and appear in the table of contents
- Second-level headings are numbered
01,02and so on, matching the top-level entries of the table of contents - Do not skip levels, and do not add another first-level heading in the body
Text formatting
| Style | Syntax | Result |
|---|---|---|
| Bold | **bold** | bold |
| Italic | *italic* | italic |
| Strikethrough | ~~strike~~ | |
| Bold italic | ***bold italic*** | bold italic |
| Inline code | `code` | code |
Links
External links use the full URL:
[Nuxt UI](https://ui.nuxt.com)
Internal links use the path from the site root, without the numeric file prefix or the .md extension. With multiple languages, pages in other locales include the locale prefix, such as /en/docs/...:
[Installation](/en/docs/getting-started/installation)
[request error] in the build log.Lists
Unordered lists
- Install dependencies
- Write content
- Deploy the site
- Install dependencies
- Write content
- Deploy the site
Ordered lists
- Create the
content/docsdirectory - Add your first page
- Start the dev server
1. Create the `content/docs` directory
2. Add your first page
3. Start the dev server
Nested lists
Indent child items by two spaces:
- Get Started
- Installation
- Project Structure
- Guide
- Get Started
- Installation
- Project Structure
- Guide
Tables
Tables suit props and comparisons. Add {lang="ts-type"} to types in cells for TypeScript highlighting:
| Prop | Default | Type |
|---|---|---|
name | string | |
size | md | 'sm' | 'md' | 'lg' |
| Prop | Default | Type |
| --- | --- | --- |
| `name` | | `string`{lang="ts-type"} |
| `size` | `md` | `'sm' \| 'md' \| 'lg'`{lang="ts-type"} |
Blockquotes
Documentation is only as good as what readers can get done with it.
Each page solves one problem.
> Documentation is only as good as what readers can get done with it.
>
> Each page solves one problem.
Frontmatter
The YAML block at the top of every page describes its metadata:
---
title: Installation
description: One sentence on what this page solves, also used as the SEO description and page lead.
seo:
title: Installation
---
| Field | Description |
|---|---|
title | Page title, also used in the sidebar and browser tab |
description | Page lead and default SEO description |
seo | SEO versions of title / description |
navigation | Sidebar options: title overrides the sidebar title, badge shows a badge next to it |
links | Links shown in the meta row below the lead |
category | Sidebar category the page belongs to, see Navigation |
requires | Version requirement as free text (such as Nuxt 4.1+), shown in the meta row below the lead |
difficulty | beginner, intermediate or advanced, shown in the meta row |
The number before a file name (such as 2.installation.md) only controls ordering and never appears in the URL.
Agent Discovery
The docs site serves AI agents a Markdown version of every page, a Markdown sitemap and a set of /.well-known discovery documents, so agents can find and read content without parsing HTML. This page lists every endpoint, the negotiation rules and what the layer adds.
Code Blocks
Code blocks are highlighted with github-light / github-dark and support filenames, line highlights, a copy button, and color and icon previews. Use code-group, code-tree, code-preview and code-collapse for multi-file, multi-package-manager and long examples.