Niu Shuai 08f056d412 docs: Sync zh_CN docs with English Version (#15228) vor 1 Monat
..
public bcdec15fb4 fix(web): favicon rename again vor 2 Monaten
src 08f056d412 docs: Sync zh_CN docs with English Version (#15228) vor 1 Monat
.gitignore f3da73553c sync vor 10 Monaten
README.md f3da73553c sync vor 10 Monaten
astro.config.mjs 9d29d692c6 split tui/server config (#13968) vor 1 Monat
config.mjs dc53086c1e wip(docs): i18n (#12681) vor 2 Monaten
package.json 799b2623cb release: v1.2.15 vor 1 Monat
sst-env.d.ts 24a9841322 zen: update sst version vor 1 Monat
tsconfig.json f3da73553c sync vor 10 Monaten

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.