Components

Use a Fumadocs-compatible set of documentation components rendered by Foldkit.

Foldocs includes opinionated components for the patterns that appear repeatedly in product documentation. They compile into deterministic Foldkit HTML and use the active Foldocs theme without adding a React runtime.

Callouts

Use Callout for information that must stand apart from the surrounding prose. The supported types are info, warning, error, success, and idea.

Cards

Cards present related destinations without replacing normal document links. Pass a Lucide icon name through icon, or override that name in site.icons.

Foldocs UI

Layouts, navigation, and default components.

Foldocs MDX

Portable Markdown and MDX compilation.

Steps

Wrap ordered procedures in Steps and Step. Foldocs supplies the counter, guide line, spacing, and responsive alignment.

Create the application

Run the scaffold command in an empty directory.

Write a page

Add a Markdown or MDX file under the locale content directory.

Build static output

Run the production build and deploy the generated dist directory.

Tabs

Tabs use accessible tab, tablist, and tabpanel semantics. The active value is stored in the Foldkit model, can be shared by groupId, and remains usable in prerendered output before hydration.

pnpm create foldocs my-docs

npm create foldocs@latest my-docs

Accordions

Accordions use native disclosure semantics. They work with the keyboard before the application runtime starts and can be opened by default.

Does this require React?

No. The component is rendered with Foldkit and native HTML disclosure state.

Can I style it?

Yes. Override the public fd-accordion classes or generate owned theme files.

File trees

Use Files, Folder, and File to explain generated project structure.

content

docs

index.mdx

getting-started.md

foldocs.config.ts

Component overrides

Project-owned renderers take precedence over the defaults. Register a component under the same MDX name when a product needs custom markup or behavior; all unmodified components continue to use the Foldocs implementation.

Last updated 3 ago 2026