Skip to content
Foldocs
On this pagePublic entry points

Foldocs Core

Typed configuration, manifests, navigation, and localization primitives.

foldocs-core is the framework-independent contract between content discovery, the Vite integration, and Foldkit views. It contains no browser renderer and no filesystem crawler.

Public entry points

Entry pointPurpose
foldocs-core/configEffect Schema configuration and resolved defaults
foldocs-core/manifestPage lookup and adjacent-page helpers
foldocs-core/navigationFolders, separators, roots, and layout tabs

Headless feature map

Foldocs splits the responsibilities grouped into fumadocs-core across small packages:

ResponsibilityFoldocs package
Configuration and treefoldocs-core
Content contracts@foldocs/content
Markdown compilationfoldocs-mdx
Foldkit viewsfoldocs-ui
Search contracts@foldocs/search
Discovery and output@foldocs/vite

The Core documentation follows those capabilities even when the implementation lives in a neighboring package.

Why it is separate

Adapters can create the same page metadata whether content comes from the local filesystem, a CMS, OpenAPI, AsyncAPI, or a language-reference generator. Core turns that metadata into stable application state without depending on the source. Start with the page tree and content source contract.

Runtime independence

Core exports plain typed values, Effect schemas, and deterministic helpers. It does not depend on a browser renderer, which keeps adapters, generators, and build tools reusable.

Last updated Aug 2, 2026