Componentes
Referencia completa de los componentes de Boltdocs — componentes de contenido MDX y primitivas de diseño.
Usa esta sección cuando ya sabes qué superficie de API necesitas. Para instrucciones orientadas a tareas, comienza por las Guías.
Entrypoints
| Import | Runtime | Úsalo para |
|---|---|---|
boltdocs | Node / build | defineConfig, plugins, tipos de configuración y factories JSON-LD. |
boltdocs/client | Browser / SSR | Hooks React, structured data, transiciones, colecciones y utilidades cliente. |
boltdocs/primitives | Browser / SSR | Componentes sin estilos de layout, navegación, enlaces e interacción — personalízalos vía atributos de estado data-*. |
Configuración
Configura el proyecto desde boltdocs.config.ts.
Hooks de React
Lee estado de runtime como config, rutas, tema, locale y navegación.
Utilidades
Helpers tipados para config, i18n, URLs, clipboard y texto.
Primitivas
Compón layouts y navegación sin el shell del theme por defecto.
API de Plugins
Extiende lifecycle, transforms, caches, diagnostics, server y HMR.
Structured Data
Genera y renderiza graphs JSON-LD tipados.
APIs experimentales
View Transitions, TransitionLink y file-routing experimental.
Hooks de React
La referencia de Hooks documenta cada hook público:
useConfig,useTheme,useI18n,useVersionyuseLocationuseRoutes,useSearch,useNavbar,usePageNavyuseTabs- Hooks de colecciones como
usePosts,usePostyuseRecentPosts
API de Plugins
La API de Plugins se divide en referencias de lifecycle hooks, caches, diagnostics, paths, virtual modules, middleware, server y HMR.
APIs experimentales
- Structured Data — factory y componente JSON-LD.
- Funciones Experimentales — View Transitions y file-routing de
pages-external.
Las Guías explican el workflow. Esta sección explica exports, parámetros y valores de retorno exactos.
