Skip to content

Overview

A docs site on Astro and Starlight with tabs, grouped sidebar, search and a feedback widget.

This starter turns Starlight into a docs site with a layout in the style of Tebar and GitHub Docs. You write Markdown; the layout, search and navigation come with it.

  • Tabs along the top (Guide, Reference). Each tab owns some groups.
  • A sidebar with the logo, search, the current tab’s sections, a language menu, icon links and a light/dark toggle.
  • Groups: a folder of articles with a landing page of cards you can filter by content type.
  • Article chrome: breadcrumbs, an intro line, a content-type label, “On this page” and previous/next links.
  • A feedback widget (“Was this helpful?”) that emails votes through Resend from a Pages Function.
  • Search (Pagefind) that works under a strict Content-Security-Policy.
  • Checks: lint, validate:docs, unit tests, axe accessibility tests in light and dark, Lighthouse budgets.

Structure and copy live in src/config/docs.config.ts. Articles live in src/content/docs/docs/<group>/. The look lives in src/styles/starlight.css. See Project structure.

Follow the Quick start, then Write content.