Getting Started

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

   npm

   npm install starlight-theme-black

   pnpm

   pnpm add starlight-theme-black

   Yarn

   yarn add starlight-theme-black

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 starlightThemeBlack from 'starlight-theme-black'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [
           starlightThemeBlack({
             navLinks: [{ // optional
               label: 'Docs',
               link: '/getting-started',
             }],
             footerText: //optional
               'Built & designed by [shadcn](https://twitter.com/shadcn). Ported to Astro Starlight by [Adrián UB](https://github.com/adrian-ub). The source code is available on [GitHub](https://github.com/adrian-ub/starlight-theme-black).'
          })
         ],
         title: 'My Docs',
       }),
     ],
   })

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