Getting Started

A modern and beautiful theme for Starlight.

Prerequisites

You will need to have a Starlight website set up.

If you don’t have one yet, you can follow the “Getting Started” guide in the Starlight docs to create one.

Installation

1. The Starlight Nova theme is a Starlight plugin that you can install using your favorite package manager:

   pnpm

   pnpm add starlight-theme-nova

   npm

   npm install starlight-theme-nova

   yarn

   yarn add starlight-theme-nova

   bun

   bun add starlight-theme-nova

2. Configure the plugin in your Starlight configuration in the astro.config.mjs file.

   // astro.config.mjs
   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightThemeNova from 'starlight-theme-nova'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [starlightThemeNova()], 
         title: 'My Docs',
       }),
     ],
   })

3. Start the development server to preview the theme in action.

That’s it! You should now see the Starlight Nova theme applied to your Starlight website.