Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | # Fumadocs Framework |
| 2 | |
| 3 | Composio docs is built with [Fumadocs](https://fumadocs.dev/), a Next.js-based documentation framework. |
| 4 | |
| 5 | ## Key Files |
| 6 | |
| 7 | | File | Purpose | |
| 8 | | ----------------------- | -------------------------------------- | |
| 9 | | `source.config.ts` | MDX collections and schema definitions | |
| 10 | | `lib/source.ts` | Source loaders and utility functions | |
| 11 | | `app/(home)/layout.tsx` | Home layout with navigation | |
| 12 | | `app/docs/layout.tsx` | Docs layout with sidebar | |
| 13 | | `app/global.css` | All custom styles and design tokens | |
| 14 | | `mdx-components.tsx` | MDX component registration | |
| 15 | |
| 16 | ## Design Tokens |
| 17 | |
| 18 | ```text |
| 19 | --composio-orange: #ea580c # Brand accent color |
| 20 | --composio-sidebar: #f7f5f2 # Light sidebar |
| 21 | --composio-sidebar: #252220 # Dark sidebar |
| 22 | --font-sans: 'Inter' # Body text |
| 23 | --font-mono: 'IBM Plex Mono' # Code blocks |
| 24 | ``` |
| 25 | |
| 26 | ## Content Structure |
| 27 | |
| 28 | ``` |
| 29 | content/ |
| 30 | ├── docs/ # Main documentation |
| 31 | ├── examples/ # Example guides |
| 32 | ├── changelog/ # Release notes |
| 33 | └── reference/ # SDK & API reference |
| 34 | ``` |
| 35 | |
| 36 | ## MDX Components |
| 37 | |
| 38 | Available globally without imports: |
| 39 | |
| 40 | - `Tabs`, `Tab`, `TabsList`, `TabsTrigger`, `TabsContent` |
| 41 | - `Accordion`, `Accordions` |
| 42 | - `Callout` |
| 43 | - `Step`, `Steps` |
| 44 | - `Card`, `Cards` |
| 45 | - `ProviderList` (`group="ai-sdks"`, `"agent-frameworks"`, or `"custom"`), backed by `lib/providers.ts` |
| 46 | - `FrameworkSelector`, `QuickstartFlow`, `FrameworkOption` |
| 47 | - `IntegrationTabs`, `IntegrationContent` |
| 48 | - `ToolTypeFlow`, `ToolTypeOption` |
| 49 | - `Figure`, `Video` |
| 50 | - `CapabilityCard`, `CapabilityList` |
| 51 | - `ToolkitsLanding` |
| 52 | - `StepTitle` |
| 53 | - `Glossary`, `GlossaryTerm` — filterable glossary table (see `components/glossary.tsx`) |
| 54 | - Lucide icons: `ShieldCheck`, `RouteIcon`, `Key`, `Wrench`, `Database`, `Zap`, `Rocket`, `Code`, `Blocks`, `Plug`, `Play`, `Terminal`, `Palette`, `BookOpen` |
| 55 | |
| 56 | ## Deployment |
| 57 | |
| 58 | - **Platform**: Vercel |
| 59 | - **Project**: `composio/docs` |
| 60 | - **Root directory**: `docs` (monorepo subfolder) |
| 61 | - **Build**: `bun install` and `bun run build` |
| 62 | |
| 63 | ## Common Gotchas |
| 64 | |
| 65 | 1. **CSS variables**: Use `var(--composio-orange)` not `var(--orange)`. Check `global.css` for defined variables. |
| 66 | |
| 67 | 2. **Date format**: Changelog dates must be YYYY-MM-DD format (validated in schema and runtime). |
| 68 | |
| 69 | 3. **Toolkits data**: `public/data/toolkits.json` must exist - errors are thrown, not silently ignored. |
| 70 | |
| 71 | 4. **Root directory on Vercel**: Set to `docs` with "Include files outside root directory" DISABLED. |
| 72 | |
| 73 | 5. **Mobile nav**: Always test CSS changes on mobile. Fumadocs uses different nav patterns (dropdown on mobile, horizontal on desktop). Avoid absolute positioning or pseudo-elements that assume horizontal layout. |
| 74 | |
| 75 | 6. **Twoslash in dev**: Twoslash is disabled in `bun dev` due to heap memory issues. Run `bun run build` locally to catch type errors. See `docs/agent-guidance/context/twoslash.md`. |