Buckets:
394 MB
5,654 files
Updated about 2 months ago
Ctrl+K
| Name | Size | Uploaded | Xet hash |
|---|---|---|---|
| public | 2 items | ||
| src | 680 items | ||
| .gitignore | 229 Bytes xet | 1a9a2092 | |
| README.md | 2.63 kB xet | c0688825 | |
| astro.config.mjs | 8.26 kB xet | b5c30e57 | |
| config.mjs | 533 Bytes xet | d6550dd3 | |
| package.json | 1.2 kB xet | 874e2875 | |
| sst-env.d.ts | 236 Bytes xet | 738c18ae | |
| tsconfig.json | 194 Bytes xet | 9f06d6ae |
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 |
π Want to learn more?
Check out Starlightβs docs, read the Astro documentation, or jump into the Astro Discord server.
- Total size
- 394 MB
- Files
- 5,654
- Last updated
- Jun 13
- Pre-warmed CDN
- US EU US EU