Getting Started

A Starlight theme heavily inspired by the timeless design of the legacy Astro documentation. 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 Vintage theme is a Starlight plugin that you can install using your favorite package manager:

   npm

   npm i starlight-theme-vintage

   pnpm

   pnpm add starlight-theme-vintage

   yarn

   yarn add starlight-theme-vintage

   ni

   ni starlight-theme-vintage

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

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

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