defineConfig

Definir configuraciones validadas por TypeScript dentro de boltdocs.config.ts.

La utilidad defineConfig es un asistente de configuración en tiempo de compilación que proporciona autocompletado de tipos TypeScript y verificación de propiedades.

FirmaLink

ts
function defineConfig(config: BoltdocsConfig): BoltdocsConfig

Ejemplo: Estructura de ConfiguraciónLink

ts
// boltdocs.config.ts
import { defineConfig } from 'boltdocs'
import mermaidPlugin from '@bdocs/plugin-mermaid'

export default defineConfig({
  siteUrl: 'https://docs.example.com',
  title: 'My Custom Framework',
  description: 'Clean developers guides.',
  theme: {
    logo: {
      light: '/logo-light.svg',
      dark: '/logo-dark.svg'
    },
    tabs: [
      { id: 'guides', title: 'Guides', href: '/docs/guides' },
      { id: 'api', title: 'API Reference', href: '/docs/api' }
    ]
  },
  plugins: [
    mermaidPlugin({
      themes: {
        light: { primaryColor: '#f3f4f6' }
      }
    })
  ]
})
Last updated on October 18, 2026

Was this page helpful?