2.8 KiB
Fumadocs Framework
Composio docs is built with Fumadocs, a Next.js-based documentation framework.
Key Files
| File | Purpose |
|---|---|
source.config.ts |
MDX collections and schema definitions |
lib/source.ts |
Source loaders and utility functions |
app/(home)/layout.tsx |
Home layout with navigation |
app/docs/layout.tsx |
Docs layout with sidebar |
app/global.css |
All custom styles and design tokens |
mdx-components.tsx |
MDX component registration |
Design Tokens
--composio-orange: #ea580c # Brand accent color
--composio-sidebar: #f7f5f2 # Light sidebar
--composio-sidebar: #252220 # Dark sidebar
--font-sans: 'Inter' # Body text
--font-mono: 'IBM Plex Mono' # Code blocks
Content Structure
content/
├── docs/ # Main documentation
├── examples/ # Example guides
├── changelog/ # Release notes
└── reference/ # SDK & API reference
MDX Components
Available globally without imports:
Tabs,Tab,TabsList,TabsTrigger,TabsContentAccordion,AccordionsCalloutStep,StepsCard,CardsProviderCard,ProviderGridFrameworkSelector,QuickstartFlow,FrameworkOptionIntegrationTabs,IntegrationContentToolTypeFlow,ToolTypeOptionFigure,VideoCapabilityCard,CapabilityListToolkitsLandingStepTitleGlossary,GlossaryTerm— filterable glossary table (seecomponents/glossary.tsx)- Lucide icons:
ShieldCheck,RouteIcon,Key,Wrench,Database,Zap,Rocket,Code,Blocks,Plug,Play,Terminal,Palette,BookOpen
Deployment
- Platform: Vercel
- Project:
composio/docs - Root directory:
docs(monorepo subfolder) - Build:
bun installandbun run build
Common Gotchas
-
CSS variables: Use
var(--composio-orange)notvar(--orange). Checkglobal.cssfor defined variables. -
Date format: Changelog dates must be YYYY-MM-DD format (validated in schema and runtime).
-
Toolkits data:
public/data/toolkits.jsonmust exist - errors are thrown, not silently ignored. -
Root directory on Vercel: Set to
docswith "Include files outside root directory" DISABLED. -
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.
-
Twoslash in dev: Twoslash is disabled in
bun devdue to heap memory issues. Runbun run buildlocally to catch type errors. Seedocs/agent-guidance/context/twoslash.md.