Guides
- Configure the site
Identity, navigation, version, social images, footer and accent colour - the options every site sets.
- Landing page
The landing page from config (hero, live demo, features, steps, gallery strip, call to action), or your own page built from the same components.
- Docs
Local MDX pages, mounting markdown from your repo or another one (titles, link rewriting, order, exclude, edit links), and the generated sidebar.
- Live examples
Write an example once; the page shows the code and runs it - inline or in an iframe, editable, or through your own runner module.
- Markdown
Everything GitHub-flavoured markdown renders, on every page - alerts, task lists, footnotes, math, Mermaid diagrams, emoji - plus code blocks with titles, terminals, diffs, line numbers and copy buttons.
- Gallery
Gallery entries (YAML, JSON or Markdown), posters, kinds and tags, the /gallery/ page with filters, and the strip on the landing page.
- Mirrors
Serve static HTML/JS folders (a playground, demos, your library's src/) byte for byte next to the docs, with their relative layout intact.
- Docs generation
Keep API tables and other facts in your markdown in sync with the code - docs:gen fills marked blocks, docs:check fails CI when one is stale.
- Theming
Restyle the whole site - landing, gallery and docs - from a few CSS tokens, for light and dark, with custom CSS and fonts.
- Overriding components
Replace the header, footer, hero, landing body, gallery card or gallery page with your own components, and pass anything else through to Starlight.
- Deploying
Deploy from your machine with npm run deploy, or opt into CI (init --ci) for checks, a preview per pull request and production from tags; Cloudflare Workers static assets, custom domains and API token permissions.
- Upgrading
Update the package, the reusable workflow pin and the files init copied, and what to check afterwards.