openstatus.dev
Openstatus
www.openstatus.dev
1# Starlight Starter Kit: Basics
2
3[](https://starlight.astro.build)
4
5```
6npm create astro@latest -- --template starlight
7```
8
9[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
13
14> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
15
16## 🚀 Project Structure
17
18Inside of your Astro + Starlight project, you'll see the following folders and files:
19
20```
21.
22├── public/
23├── src/
24│ ├── assets/
25│ ├── content/
26│ │ ├── docs/
27│ │ └── config.ts
28│ └── env.d.ts
29├── astro.config.mjs
30├── package.json
31└── tsconfig.json
32```
33
34Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
35
36Images can be added to `src/assets/` and embedded in Markdown with a relative link.
37
38Static assets, like favicons, can be placed in the `public/` directory.
39
40## 🧞 Commands
41
42All commands are run from the root of the project, from a terminal:
43
44| Command | Action |
45| :------------------------ | :----------------------------------------------- |
46| `npm install` | Installs dependencies |
47| `npm run dev` | Starts local dev server at `localhost:4321` |
48| `npm run build` | Build your production site to `./dist/` |
49| `npm run preview` | Preview your build locally, before deploying |
50| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
51| `npm run astro -- --help` | Get help using the Astro CLI |
52
53## 👀 Want to learn more?
54
55Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).