MkDocs

Write docs

Organize pages, navigation, metadata, links, and assets.

Page structure

Every page starts with frontmatter and continues with standard Markdown or MDX:

---
title: Billing
description: Configure plans, products, and customer billing.
icon: CreditCard
---

## Create a product

Write the page content here.

The title and description are used by navigation, search, metadata, and social cards. icon accepts a Lucide icon name.

Use meta.json in a folder to name the group and control page order:

{
  "title": "Guides",
  "icon": "Blocks",
  "pages": ["authoring", "components", "deployment"]
}
  • Use relative links for nearby documentation pages.
  • Put downloadable or static files in public/ and reference them from /.
  • Register shared React components in press.config.tsx.

Built-in outputs

Each build creates the search index, per-page Markdown, llms.txt, sitemap.xml, and Open Graph images. Update src/site.config.ts before publishing.

Last updated on

On this page