Preset Options

Configure every Nova-owned setting for @cbnventures/docusaurus-preset-nova in docusaurus.config.ts.

Top-Level Options

presets: [[
  '@cbnventures/docusaurus-preset-nova',
  {
    preset: 'envoy',
    overrides: { /* ... */ },
    plugins: { /* ... */ },
    analytics: { /* ... */ },
    persistentCache: false,
    search: { /* ... */ },
    progressBar: true,
    iconSafelist: ['logos:slack'],
    maxBundleFileSize: 3,
  },
]],

Overrides

Override any visual property of the active preset. Unspecified values keep the preset defaults.

Only four override categories are exposed: colors, fonts, navbar, and footer. The preset's shape, depth, and motion characteristics are part of its identity and cannot be overridden — switch to a different preset if you need a different feel.

Colors

Each color category accepts a { light, dark } pair of hex strings. Both keys are optional within each category — omitted values fall back to the active preset's defaults.

The primary and secondary colors expand to 11-level shade scales (50 through 950) as CSS custom properties. The text, border, warning, and danger colors are used as single values plus derived color-mix tokens.

Fonts

Navbar and Footer

Analytics

Webpack Cache

Nova avoids persistent webpack cache files by default so multilingual development sessions and builds do not accumulate a separate disk cache for every locale and compiler target.

• docusaurus start uses webpack's in-memory cache for fast rebuilds during the current development session.
• docusaurus build disables webpack caching because a production build does not benefit from retaining those files afterward.

Set persistentCache to true to leave Docusaurus's filesystem cache behavior unchanged. This can make repeated builds faster in environments with enough disk space.

{
  preset: 'envoy',
  persistentCache: true,
}

Search

See Search for the full options table and explanation.

Progress Bar

Set progressBar to true to use all Nova defaults, or pass an object to override individual behavior. The bar starts when Docusaurus begins a client-side route update and completes after the next route has been preloaded. It does not flash during the initial page load.

{
  preset: 'envoy',
  progressBar: {
    showSpinner: false,
    speed: 250,
  },
}

The supported fields above receive stable Nova defaults. Additional advanced fields are forwarded to the bundled progress implementation, but Nova does not assign them a compatibility guarantee.

Icon Safelist

The preset bundles only the icons it finds by scanning your docs, blog, and src files plus the resolved themeConfig at build time. Any icon referenced with a static prefix:name string — in MDX, component props, or config — is discovered automatically and tree-shaken into the build, so there is nothing to install and the client never ships icons you don't use.

Use iconSafelist for the one case the scan can't see: an icon identifier assembled dynamically at runtime (for example, built from a variable). List those identifiers so they are always bundled.

{
  preset: 'envoy',
  iconSafelist: ['logos:slack', 'mdi:rocket-launch'],
}

Bundle Size

A production build (docusaurus build) fails if any emitted JavaScript file is larger than maxBundleFileSize mebibytes (MiB) (default 3). This catches a bundle-size regression — an accidentally eager import, an un-tree-shaken dependency — at build time, long before it slows real page loads or trips a host's per-file limit.

The error names the offending files.

Raise the limit if a site has a genuinely large legitimate chunk, or set it to false to turn the check off entirely.

{
  preset: 'envoy',
  maxBundleFileSize: 5, // mebibytes (MiB); or false to disable
}

Included Stack

Nova installs and coordinates more than the four configurable content plugins. See Preset Stack for every included plugin, runtime, build-time integration, CLI dependency, and required peer—plus how each one is activated and used.