Getting Started

Starlight theme inspired by the NextJS docs.

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. starlight-nextjs-theme is a Starlight plugin. Install it by running the following command in your terminal:

   npm

   npm install starlight-nextjs-theme

   pnpm

   pnpm add starlight-nextjs-theme

   Yarn

   yarn add starlight-nextjs-theme

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 starlightNextjsTheme from 'starlight-nextjs-theme'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [starlightNextjsTheme()],
         title: 'My Docs',
       }),
     ],
   })

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

Acknowledgments

Thanks to HiDeoo for the generator-starlight-plugin, which helps speed up starting a new project, and for the Starlight Rapide theme, which I used as the basis for the content examples in these docs.

Thanks to Adrián UB for the starlight-theme-black, which inspired me to create this theme.

Thanks to Chris Swithinbank for the starlight-theme-flexoki, which inspired me to write this lovely acknowledgments section.