Getting Started
Conventions and the MDX components available when writing docs
Docs are authored as MDX in content/docs. This page shows the building
blocks you can use — all rendered by Fumadocs out of the box.
Callouts
Use callouts to highlight useful context.
Use
warn for things that can bite.Use
error for things that will bite.Steps
Write a page
Add an .mdx file under content/docs.
Add front matter
Give it a title and description.
Commit
The pipeline builds and publishes it.
Tabbed content
npm installpnpm installyarnCode blocks
Syntax highlighting, a title, and line highlighting come for free:
export async function createOrder(input: OrderInput) {
const res = await fetch('/v1/orders', {
method: 'POST',
headers: { authorization: `Bearer ${token}` },
body: JSON.stringify(input),
});
if (!res.ok) throw new Error(`Gateway error: ${res.status}`);
return res.json();
}Tables
| Field | Type | Notes |
|---|---|---|
id | string | Server-assigned |
status | enum | pending → complete |
createdAt | datetime | ISO 8601 |
Every heading here also feeds the On this page table of contents on the right.