Starlight

Documentation

Quickstart

Installation

npm create astro@latest -- --template starlight

Configuration

Starlight is a documentation theme built on the Astro framework. All of the recommendations for the Astro framework apply to Starlight.

Use the default rendering mode output: 'static' to prerender the entire site.

Update your site metadata in astro.config.mjs (e.g. site).

Be aware of your trailingSlash configuration.

The docs explain how to use getStaticPaths with dynamic routes (e.g. [id].astro) for Static (SSG) Mode.

Static (SSG) Mode supports Static File Endpoints, Middleware, and Content Collections too.

Deployment

Build

npm run build

Preview

npx --yes serve@latest dist

Deploy

npx --yes bunny-launcher@latest --interactive