Skip to content

Installation

@nebari/starlight is a Starlight plugin. If you already have a Starlight site, adding it is two changes: install the package and register the plugin. If you’re starting from scratch, create a Starlight project first and then follow along.

  • Node.js 18.17 or newer (or Bun 1.1+). The theme is tested against both.
  • An Astro + Starlight project. To create one, run npm create astro@latest -- --template starlight.

Add the theme with your package manager of choice:

Terminal window
npm install @nebari/starlight
  1. Open astro.config.mjs at the root of your project.

  2. Import the theme and pass it to Starlight’s plugins array:

    astro.config.mjs
    import starlight from '@astrojs/starlight';
    import { nebari } from '@nebari/starlight';
    import { defineConfig } from 'astro/config';
    export default defineConfig({
    integrations: [
    starlight({
    title: 'My Pack',
    plugins: [nebari()],
    }),
    ],
    });
  3. Start the dev server and open the site:

    Terminal window
    npm run dev

That’s it — the header logo, brand colors, fonts, footer, and search are now active. There is no CSS to import and no fonts to download separately; the plugin registers everything.