fork/glide
git clone https://git.julia.blue/fork/glide
577e3ec
main
files
| public/ | |
| src/ | |
| .gitignore | 229 B |
| README.md | 2.6 KiB |
| astro.config.mjs | 1.5 KiB |
| package-lock.json | 251.0 KiB |
| package.json | 403 B |
| tsconfig.json | 109 B |
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.