Skip to main content

Manual Setup

For existing Docusaurus v3 projects that need the preset added by hand.

Install the Package

bash
npm install @cbnventures/docusaurus-preset-nova

Configure the Preset

Replace the default @docusaurus/preset-classic entry in docusaurus.config.ts with the Nova preset:

docusaurus.config.ts
ts
import type { DocusaurusNovaConfig } from '@cbnventures/docusaurus-preset-nova/types/config';

const config: DocusaurusNovaConfig = {
  // ...
  presets: [[
    '@cbnventures/docusaurus-preset-nova',
    {
      preset: 'envoy',
    },
  ]],
};

export default config;

ECMAScript module package

The Nova preset is published as ESM. Configure it through Docusaurus as shown above; no package-boundary change is required in the consuming site. Node scripts that import the preset directly must use import or dynamic import() instead of require().

The preset field is required. Choose one of 'envoy', 'foundry', 'lantern', 'marshal', 'sentinel', or 'signal'.

Override Defaults

Pass an overrides object to customize individual values without switching presets. Each color category accepts a { light, dark } pair, and either key can be omitted to keep the preset default for that mode:

docusaurus.config.ts
ts
presets: [[
  '@cbnventures/docusaurus-preset-nova',
  {
    preset: 'envoy',
    overrides: {
      colors: {
        primary: { light: '#2563eb', dark: '#60a5fa' },
      },
      navbar: 'canopy',
    },
  },
]],

Only colors, fonts, navbar, and footer are overridable. For the full list of override options, see Preset Options.