Previews

Usage

1. Install the theme package to your project with your preferred package manager:

   npm install @catppuccin/starlight
   pnpm add @catppuccin/starlight
   yarn add @catppuccin/starlight

2. Add the theme to your Starlight config.

   import catppuccin from "@catppuccin/starlight";
   
   export default defineConfig({
     // ...
     integrations: [
       starlight({
         // ...
         plugins: [catppuccin()],
       }),
     ],
   });

3. (Optional) Customize your theme for light/dark mode using flavor and accent.

   import catppuccin from "@catppuccin/starlight";
   
   export default defineConfig({
     // ...
     integrations: [
       starlight({
         // ...
         plugins: [
           catppuccin({
             dark: { flavor: "macchiato", accent: "sky" },
             light: { flavor: "latte", accent: "sky" },
           }),
         ],
       }),
     ],
   });

Development

[!IMPORTANT]
catppuccin/whiskers is required to re-generate the themes directory.

pnpm install
pnpm build

💝 Thanks to

• TheOtterlord
• Louis Escher