Skip to content

Introduction

Welcome to astrodocs-demo: a static documentation site built with Astro Starlight and deployed on GitHub Pages.

  • Run locally: npm run dev then open the URL shown in the terminal.
  • Add content: Add Markdown or MDX files under src/content/docs/; they appear in the sidebar automatically.
  • Build: npm run build produces the static site in dist/.
  • astro.config.mjs — Astro and Starlight configuration (site URL, base path, integration options).
  • src/content/docs/ — Documentation pages; file structure drives the sidebar.
  • public/ — Static assets (favicon, images) served as-is.

This demo uses only native Starlight features: sidebar from file structure, automatic table of contents, built-in search, and light/dark theme.