Getting Started

Setup Instructions

1. Setup a Starlight Site: https://starlight.astro.build/getting-started/

2. Install the starlight-utils plugin:

   npm

   npm i @lorenzo_lewis/starlight-utils

   yarn

   yarn add @lorenzo_lewis/starlight-utils

   pnpm

   pnpm add @lorenzo_lewis/starlight-utils

3. Update the integrations.starlight.plugins object in astro.config.mjs to include the starlight-utils plugin:

   astro.config.mjs

   import { defineConfig } from "astro/config";
   import starlight from "@astrojs/starlight";
   import starlightUtils from "@lorenzo_lewis/starlight-utils";
   
   // https://astro.build/config
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [starlightUtils()],
       }),
     ],
   });

4. Go to the Configuration Guide to learn how to set up the different utilities ✨