Astro Starlight Basics

astro-starlight.md

Starlight Basics

Create new starlight project in a folder called "starlight"

npm create astro@latest -- --template starlight

1. 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.
2. Images can be added to src/assets/ and embedded in Markdown with a relative link.
3. Static assets, like favicons, can be placed in the public/ directory.

🚀 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

🧞 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.

Github Pages

1. Create a new file in your project at .github/workflows/deploy.yml and paste in the YAML from: https://docs.astro.build/en/guides/deploy/github/
2. In Settings > Pages set Source to Github Actions
3. Push to the server!

More Articles

• A Complete Guide to Build a Documentation Site with Astro Starlight (2024)
• Similar projects: https://vitepress.dev/