Contributing
MDX components
Reference for built-in and custom documentation components.
Use these components in any page under content/docs/. They are registered in src/components/mdx.tsx.
Callouts
Info
Use for neutral context, tips that are not warnings.
Warning
Use before destructive or irreversible actions.
Error
Use when something failed or will fail without action.
Success
Use to confirm a step completed correctly.
Steps
Install dependencies with
pnpm install.Copy
.env.example to .env.local.Run
pnpm dev and open the docs site.Tabs
pnpm install
pnpm devbun install
bun run devnpm install
npm run devCards
Accordions
File tree
content/docs
components/mdx.tsx
app/docs
Code blocks
Filename and copy are provided by Fumadocs defaults:
export const appName = 'Ragnarock';Environment variables
Prop
Type
Diagrams (Mermaid)
Fenced mermaid blocks are converted automatically:
Or use the explicit component:
Screenshots
Place images under public/images/ and reference them:
Type table
For API fields or config objects:
Prop
Type