Referencia de la API
Referencia completa de la API de Boltdocs — hooks de React, componentes de diseño y asistentes de configuración.
Esta sección ofrece documentación de referencia para todas las API públicas exportadas por los paquetes del framework boltdocs.
Descripción General de la Arquitectura
Boltdocs divide sus módulos en puntos de entrada separados para aislar las configuraciones del lado del servidor de los elementos interactivos del lado del navegador:
| Importación del Módulo | Propósito | Entorno |
|---|---|---|
boltdocs | Esquemas de configuración del proyecto y plugins | Node / Build |
boltdocs/client | Componentes React con estilos predeterminados, hooks de contexto y asistentes | Browser / SSR |
boltdocs/primitives | Elementos primitivos sin estilos para crear diseños personalizados | Browser / SSR |
Hooks de React
Los hooks te permiten consumir el estado de Boltdocs (tema activo, enlaces de navegación, selecciones de idioma, índices de búsqueda) directamente en tus componentes personalizados.
useConfig
Obtener el objeto de configuración global parseado de Boltdocs.
useSearch
Obtener la consulta de búsqueda, resultados y controles de apertura/cierre.
useTheme
Acceder y alternar entre los temas de interfaz claro y oscuro.
useNavbar
Obtener las configuraciones de navegación activas, detalles del logo y enlaces sociales.
useRoutes
Leer la lista de metadatos de todas las páginas generadas.
useBreadcrumbs
Acceder a las migas de pan de navegación de la ubicación actual.
usePageNav
Determinar las rutas de páginas anterior o siguiente lógicas.
useI18n
Administrar y cambiar entre diferentes idiomas/regiones.
useVersion
Administrar y cambiar entre diferentes versiones de documentación.
useTabs
Obtener las pestañas de categoría y los valores de estilo del indicador deslizante activo.
useLocation
Wrapper del hook de ubicación de React Router DOM para acceder a los metadatos de la ruta actual del router.
useLocalizedTo
Hook de utilidad para agregar automáticamente segmentos de idioma y versión a los enlaces de rutas.
Utilidades
Funciones auxiliares para combinar estilos, indexación de traducciones, compilación de texto y validación de configuración.
cn
Combinar estilos de Tailwind.
getTranslated
Utilidad de búsqueda por idioma.
reactToText
Extraer texto plano de JSX.
copyToClipboard
Escribir en el portapapeles.
defineConfig
Asistente de configuración TypeScript.
Interfaz de Línea de Comandos (CLI)
Boltdocs incluye comandos de CLI para construir, previsualizar, depurar y auto-reparar estructuras de documentación.
Desarrollo de Plugins
Referencias para autores que construyen plugins de Boltdocs — la forma del PluginContext, los hooks del lifecycle y cada namespace enriquecido (caches, diagnostics, paths, virtual modules, slots, middleware, server, hmr) expuesto al código de los plugins.
PluginContext
Objeto de contexto base, campos base y descripción general de namespaces.
Caches
Caché de transformación, caché de rutas y caché FIFO en memoria.
Diagnostics
Reporte estructurado de diagnósticos con niveles de severidad.
Paths
Resolución segura de rutas con protección contra directory traversal.
Virtual Modules
Declaraciones de módulos virtuales en runtime para Vite.
Middleware
Pipeline de middleware de transformación (source, MDX, HTML).
Server
Middleware HTTP y hooks del ciclo de vida del servidor.
HMR
Observación de archivos y eventos HMR personalizados.
Exportaciones de Tipos
Importa las interfaces de TypeScript directamente desde 'boltdocs' (para esquemas de configuración) o 'boltdocs/client' (para elementos de enrutamiento del lado del cliente):
Tipos de Configuración de Build
import type { BoltdocsConfig, BoltdocsPlugin } from 'boltdocs'
Tipos de Contexto del Cliente
import type { RouteMeta, SidebarGroup, Heading } from 'boltdocs/client'