claude@clouddev1
fb536b4245
installation.md predated the install/packaging work that landed on main: - drop the "once published" placeholders now that v0.2.0 is live - fix the Homebrew/Scoop commands (tap/bucket-add forms; the bare `brew install rdbms-playground` was wrong) - add the curl|sh and PowerShell one-line installers (ADR-0055), `cargo install` / `cargo binstall` (ADR-0056), and prebuilt binaries - present winget as coming-soon (PR awaiting the public catalogue) command-line-options.md: add `-V`/`--version` and the in-app `version` command (ADR-0054).
Starlight Starter Kit: Basics
pnpm 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 |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm 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.