defineConfig
Define TypeScript-validated configurations inside boltdocs.config.ts.
The defineConfig utility is a compile-time configuration helper providing TypeScript type autocompletion and property checking.
Signature
ts
function defineConfig(config: BoltdocsConfig): BoltdocsConfig
Example: Configuration Structure
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
