Starlight Starter Kit: Basics

npm create astro@latest -- --template starlight

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   └── docs/
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI
npm run deploy	Build and deploy to production (Cloudflare Pages)

Deployment

This site is deployed to Cloudflare Pages at spatial-shanghai.ritsdev.top.

Setup

1. Log in to Cloudflare: npx wrangler login
2. Verify: npx wrangler whoami

Production

npm run deploy

Builds the site and deploys to the main branch (production environment).

Preview

astro build && wrangler pages deploy dist --project-name spatial-shanghai

Omitting --branch main creates a preview deployment with a unique URL like https://<hash>.spatial-shanghai.pages.dev.

Configuration

• Pages project: spatial-shanghai
• Production branch: main
• Custom domain: spatial-shanghai.ritsdev.top

👀 Want to learn more?

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.