GuidesDocs
Write a Doc Page
Add a new page to the documentation.
Docs are in beta — content is improving rapidly. Found something missing? Open an issue on GitHub or reach out on Twitter (X).
Docs live in content/docs/ as .mdx files, powered by fumadocs. Each file maps to a URL under /docs/.
Create a Page
- Create an
.mdxfile in the appropriate folder:
content/docs/guides/my-guide.mdx- Add frontmatter:
---
title: My Guide
description: A short description of this page.
---
## Overview
Your content here.Register in meta.json
Each folder has a meta.json that controls the page order in the sidebar. Add your new page to the pages array:
// content/docs/guides/meta.json
{
"title": "Guides",
"pages": ["existing-page", "my-guide"]
}Pages appear in the sidebar in the order listed.
Nested Sections
To create a sub-section (e.g., guides/auth/google):
- Create a subfolder:
content/docs/guides/auth/ - Add
meta.jsonin the subfolder listing its pages - Reference the subfolder name in the parent
meta.json
// content/docs/guides/meta.json
{
"title": "Guides",
"pages": ["auth", "other-page"]
}MDX Features
You can use standard Markdown plus MDX components from fumadocs:
import { Callout } from 'fumadocs-ui/components/callout'
<Callout type="info">
This is a callout.
</Callout>Available callout types: info, warn, error.
Preview Locally
pnpm devNavigate to http://localhost:3000/docs/guides/my-guide.