Files
composiohq__composio/fumadocs
2026-01-13 16:36:32 -08:00
..
2025-12-22 18:57:31 -08:00
2025-12-22 18:57:31 -08:00

Composio Docs

Documentation site for Composio, built with Fumadocs.

Getting Started

bun install
bun run dev

Open http://localhost:3000.

Project Structure

fumadocs/
├── app/                  # Next.js app router
├── content/              # MDX content
│   ├── docs/
│   ├── examples/
│   ├── changelog/
│   └── reference/
├── components/           # React components
├── lib/                  # Utilities
└── public/               # Static assets

Adding Content

Create an .mdx file in content/, add frontmatter, then add to meta.json:

---
title: Page Title
description: Brief description
---

Content here...

Components

<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>

Sidebar

Each folder has meta.json for ordering:

{
  "pages": ["page-one", "page-two"]
}

TypeScript Code Blocks

All TypeScript code blocks in MDX files are type-checked at build time using Twoslash. This ensures docs stay in sync with the SDK.

  • Use // @noErrors to skip checking for partial snippets
  • Use // ---cut--- to hide setup code from output
  • Run bun run build locally to validate before pushing

See CLAUDE.md for detailed patterns and troubleshooting.

Commands

Command Description
bun run dev Dev server
bun run build Production build (validates TS code blocks)
bun run types:check Type check