#
Configuration
#
Full Example
docs({
dir: './docs', // required — path to markdown files
title: 'My Project', // required — shown in header and page titles
basePath: '/docs', // optional — base route (default: '/docs')
subtitle: 'API Docs', // optional — text shown next to logo (default: 'docs')
version: 'v1.0.0', // optional — version badge shown instead of subtitle
theme: {
preset: 'default', // optional — built-in theme preset
accentColor: '#58a6ff', // optional — overrides preset accent color
logo: 'MY DOCS', // optional — header logo text (default: title)
vars: { // optional — CSS variable overrides
'--bg': '#0f0f0f',
'--font': '"IBM Plex Mono", monospace'
},
customCss: ` // optional — injected after base styles
.header-logo { font-size: 1.25rem; }
`
}
})
#
Options
| Option |
Type |
Required |
| dir |
string |
Yes |
| title |
string |
Yes |
| subtitle |
string |
No |
| version |
string |
No |
| basePath |
string |
No |
| theme |
object |
No |
#
Notes
Configuration is fully typed with TypeScript.