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.
Prerequisites
Section titled “Prerequisites”- 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.
Install the package
Section titled “Install the package”Add the theme with your package manager of choice:
npm install @nebari/starlightpnpm add @nebari/starlightbun add @nebari/starlightyarn add @nebari/starlightRegister the plugin
Section titled “Register the plugin”-
Open
astro.config.mjsat the root of your project. -
Import the theme and pass it to Starlight’s
pluginsarray: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()],}),],}); -
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.
Next steps
Section titled “Next steps”- Follow the Quickstart to scaffold a full pack.
- See Configuration for the available options.