Getting Started

A Starlight theme based on the Flexoki colour palette.

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

   npm

   npm install starlight-theme-flexoki

   pnpm

   pnpm add starlight-theme-flexoki

   Yarn

   yarn add starlight-theme-flexoki

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

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

Acknowledgments

Thanks to HiDeoo for 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 Steph Ango for open-sourcing the Flexoki colour palette.