
Astro Starlight is a full-featured documentation theme built on top of the Astro framework. It provides everything you need to build a beautiful, high-performance documentation website with a great authoring experience.
Core Features
- Markdown & MDX Support: Write content using standard Markdown or leverage the power of MDX to include interactive components.
- Search: Built-in search functionality that indexes your content for easy navigation.
- Internationalization (i18n): Support for multiple languages to reach a global audience.
- SEO-friendly: Automatic sitemaps, and other features to ensure your documentation is discoverable.
- Easy Configuration: A simple
starlight.config.tsfile to customize your site.
Getting Started
- Installation: Create a new Starlight project with
bun create astro --template starlight. - Project Setup: Configure your site in
starlight.config.ts. - Development: Start the development server with
bun dev. - Content: Add your content in the
src/content/docsdirectory. - Deployment: Deploy your site to any static hosting provider.
Related Tools
- Astro : The underlying framework that powers Starlight, designed for building fast, content-driven websites.
- Hugo : A popular static site generator known for its speed and flexibility, often used for similar documentation purposes.
Projects using Astro Starlight
- Astro Starlight Demo : A demo project showcasing the ease of getting started with Astro Starlight for building modern websites.