Pages

How to create and organize documentation pages

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.
FieldRequiredDescription
titleYesPage title shown in the browser tab and sidebar
descriptionNoMeta 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 and italic text
  • Inline code and fenced code blocks
  • Links and images
  • Ordered and unordered lists
  • Tables and blockquotes
  • Headings (##, ###, ####)

Headings on the page automatically appear in the right sidebar as a table of contents.