Skip to content
Patterson Design System

Getting started

This is a ready-to-run Starlight project skinned in the Patterson Companies brand. Scaffold it, run it, and start writing.

Prerequisites

Section titled “Prerequisites”

Node 20 or newer, or Bun 1.1 or newer. The commands below use Bun. npm works identically.

Scaffold

Section titled “Scaffold”
Terminal window
bun create patterson-starlight my-docs
cd my-docs

If the template is not registered locally, copy it out of the plugin instead:

Terminal window
cp -R "${CLAUDE_PLUGIN_ROOT}/ds/templates/starlight" my-docs
cd my-docs
bun install

Run

Section titled “Run”
Terminal window
bun run dev

The dev server serves the themed docs at http://localhost:4321. Content and style edits hot-reload.

Add a page

Section titled “Add a page”

Create a Markdown or MDX file under src/content/docs/. Its folder decides where it lands in the sidebar. guides/ and reference/ are autogenerated, so a new file in either shows up with no config change.

---
title: Placing an order
description: How to submit an order through the API.
---


Your content here.

Every page needs a title. The description feeds search and social previews.

Point it at a domain

Section titled “Point it at a domain”

Two fields in astro.config.mjs control deployment:

  • site is the deployed origin. It drives canonical URLs, the sitemap, and social previews. Both are commented out in the starter until the target is known.
  • base is the sub-path, needed only when the site is not served from the root of its domain, as with GitHub Pages project sites.

Re-theme

Section titled “Re-theme”

All brand mapping lives in src/styles/patterson.css, which remaps Starlight’s --sl-* variables onto Patterson tokens. Change a value there and both themes update. Theming walks the full surface.