2025-12-02 16:05:59 +00:00
..
2025-11-30 14:04:27 -06:00
2025-05-30 20:48:36 -04:00
2025-11-08 01:59:02 +00:00
2025-12-02 16:05:59 +00:00
2025-05-30 20:48:36 -04:00
2025-11-23 20:59:37 +00:00
2025-05-30 20:48:36 -04:00

Starlight Starter Kit: Basics

Built with Starlight

npm create astro@latest -- --template starlight

Open in StackBlitz Open with CodeSandbox Deploy to Netlify Deploy with Vercel

๐Ÿง‘โ€๐Ÿš€ 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

๐Ÿ‘€ Want to learn more?

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