Skip to content

Quick start

Quickstart

Create your repo from the template, install, and see the docs in the browser.

You need Node 26 and pnpm 12 (see .node-version and packageManager in package.json).

Use Use this template on GitHub, or:

Terminal window
gh repo create my-docs --template milzamsz/astro-starlight-starter --clone
cd my-docs
Terminal window
pnpm install
pnpm dev

Open http://localhost:4321. The root redirects to /docs/.

  1. Set the name and URL in src/config/site.config.ts.
  2. Edit groups, tabs and links in src/config/docs.config.ts.
  3. Replace the articles under src/content/docs/docs/.
  4. Pick your brand color: Customize the look.
Terminal window
pnpm lint
pnpm test
pnpm build

pnpm build also builds the search index. Preview the result with pnpm preview.

Write content and deploy to Cloudflare Pages.