Getting Started

Starlight theme inspired by Shadcn docs

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

starlight-theme-black is a Starlight plugin. Install it by running the following command in your terminal:
- npm
- pnpm
- Yarn
Terminal window
npm install starlight-theme-black
Terminal window
pnpm add starlight-theme-black
Terminal window
yarn add starlight-theme-black

Configure the plugin in your Starlight configuration in the astro.config.mjs file.

import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightThemeBlack from 'starlight-theme-black'

export default defineConfig({
  integrations: [
    starlight({
      plugins: [starlightThemeBlack()],
      title: 'My Docs',
    }),
  ],
})

Start the development server to preview the plugin in action.