Components
Every component Boltdocs ships, organized by purpose — from MDX content helpers to layout primitives.
Use this section when you know the API surface you need. For task-oriented instructions, start with the Guides.
Entry points
| Import | Runtime | Use it for |
|---|---|---|
boltdocs | Node / build | defineConfig, plugins, config types, JSON-LD factories. |
boltdocs/client | Browser / SSR | React hooks, structured data, transitions, collections, and client utilities. |
boltdocs/primitives | Browser / SSR | Style-neutral layout, navigation, link, and interaction components — theme them via data-* state attributes. |
Configuration
Configure the project through boltdocs.config.ts.
React Hooks
Read runtime state such as config, routes, theme, locale, and navigation.
Utilities
Small typed helpers for config, i18n, URLs, clipboard, and text.
Primitives
Compose custom layouts and navigation without the default theme shell.
Plugin API
Extend lifecycle, transforms, caches, diagnostics, server, and HMR.
Structured Data
Generate and render type-safe JSON-LD graphs.
Experimental APIs
View Transitions, TransitionLink, and experimental file routing.
React hooks
The Hooks reference documents the public hooks individually:
useConfig,useTheme,useI18n,useVersion, anduseLocationuseRoutes,useSearch,useNavbar,usePageNav, anduseTabs- collection hooks such as
usePosts,usePost, anduseRecentPosts
Plugin API
The Plugin API is split into focused references for lifecycle hooks, caches, diagnostics, paths, virtual modules, middleware, server, and HMR.
Experimental APIs
- Structured Data — JSON-LD factory and component.
- Experimental Features — practical View Transitions and
pages-externalfile-routing guide.
Guides explain the workflow. This section explains exact exports, parameters, and return values.
