Skip to content

Files

Latest commit

2272dcf · Jul 4, 2024

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jun 13, 2024
May 21, 2024
Jul 4, 2024
May 30, 2024
Jul 4, 2024
Jul 4, 2024
May 15, 2024
May 21, 2024
May 29, 2024
Jul 1, 2024
May 22, 2024
May 31, 2024
May 30, 2024
May 21, 2024
May 30, 2024

Starlight Starter Kit: Basics

Built with Starlight

npm create astro@latest -- --template starlight

Open in StackBlitz Open with CodeSandbox Deploy with Vercel

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

On how to write how-to guides

https://diataxis.fr/how-to-guides/

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.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.