Getting Started

A Starlight theme inspired by the Visual Studio Code Vitesse theme. Check out the various examples to see the theme in action.

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 Openscript theme is a Starlight plugin that you can install using your favorite package manager:

   npm

   npm i starlight-theme-openscript

   pnpm

   pnpm add starlight-theme-openscript

   yarn

   yarn add starlight-theme-openscript

   ni

   ni starlight-theme-openscript

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

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

That’s it! You should now see the Starlight Openscript theme applied to your Starlight website.