Pages
How MDX files become pages, how frontmatter sets titles and descriptions, and how file paths map to URLs in your documentation site.
Every .mdx file in your project becomes a page. The file path determines the URL.
Frontmatter
Each page starts with frontmatter — metadata between --- fences:
---
title: My Page Title
description: A short description for search engines
---
Your content starts here.| Field | Required | Description |
|---|---|---|
title | Yes | Page title shown in the browser tab and sidebar |
description | No | Meta description for SEO |
File organization
Your file structure maps directly to URLs:
introduction.mdx → /introduction
quickstart.mdx → /quickstart
guides/deployment.mdx → /guides/deployment
api/users/list.mdx → /api/users/list
Markdown features
MDX supports all standard Markdown:
- Bold, italic,
inline code, and links. - Ordered and unordered lists (you're reading one).
- Fenced code blocks with syntax highlighting.
- Tables, blockquotes, and headings (
##,###,####).
Lists, tables, and blockquotes render natively:
| Format | Markdown | Renders as |
|---|---|---|
| Bold | **bold** | bold |
| Italic | *italic* | italic |
| Code | `code` | code |
| Link | [text](url) | text |
Blockquotes pull a passage out of the flow. Use them sparingly.
Headings on the page automatically appear in the right sidebar as a table of contents.