docs/README.md
Documentation site for Composio, built with Fumadocs.
bun install
bun run dev
Open http://localhost:3000.
docs/
├── app/ # Next.js app router
├── content/ # MDX content
│ ├── docs/
│ ├── examples/
│ ├── changelog/
│ └── reference/
├── components/ # React components
├── lib/ # Utilities
└── public/ # Static assets
Create an .mdx file in content/, add frontmatter, then add to meta.json:
---
title: Page Title
description: Brief description
---
Content here...
<Tabs items={['Python', 'TypeScript']}>
<Tab value="Python">...</Tab>
<Tab value="TypeScript">...</Tab>
</Tabs>
<Callout type="info">Note</Callout>
<Cards>
<Card title="Title" href="/path" />
</Cards>
Each folder has meta.json for ordering:
{
"pages": ["page-one", "page-two"]
}
All TypeScript code blocks in MDX files are type-checked at build time using Twoslash. This ensures docs stay in sync with the SDK.
// @noErrors to skip checking for partial snippets// ---cut--- to hide setup code from outputbun run build locally to validate before pushingSee CLAUDE.md for detailed patterns and troubleshooting.
| Command | Description |
|---|---|
bun run dev | Dev server |
bun run build | Production build (validates TS code blocks) |
bun run types:check | Type check |