Aiden Cline d341d26e37 update brew handling hace 3 meses
..
public 9255c507d6 Share link hotfix (#1513) hace 6 meses
src d341d26e37 update brew handling hace 3 meses
.gitignore f3da73553c sync hace 8 meses
README.md f3da73553c sync hace 8 meses
astro.config.mjs 1eeba770b1 docs: add v1.0 upgrade guide with UX changes documentation hace 3 meses
config.mjs 38e8c42cf0 ci: format hace 5 meses
package.json d49b1b25d1 release: v1.0.20 hace 3 meses
sst-env.d.ts 7447460b5a wip: zen hace 4 meses
tsconfig.json f3da73553c sync hace 8 meses

README.md

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.