You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://starlight.astro.build)
4
4
5
-
```
6
-
pnpm create astro@latest -- --template starlight
7
-
```
8
5
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
6
14
-
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
15
7
16
-
## 🚀 Project Structure
17
-
18
-
Inside 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
-
│ └── content.config.ts
28
-
├── astro.config.mjs
29
-
├── package.json
30
-
└── tsconfig.json
31
-
```
32
-
33
-
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.
34
-
35
-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36
-
37
-
Static assets, like favicons, can be placed in the `public/` directory.
38
-
39
-
## 🧞 Commands
8
+
### 🧞 Commands
40
9
41
10
All commands are run from the root of the project, from a terminal:
42
11
@@ -48,7 +17,3 @@ All commands are run from the root of the project, from a terminal:
48
17
|`pnpm preview`| Preview your build locally, before deploying |
49
18
|`pnpm astro ...`| Run CLI commands like `astro add`, `astro check`|
50
19
|`pnpm astro -- --help`| Get help using the Astro CLI |
51
-
52
-
## 👀 Want to learn more?
53
-
54
-
Check 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).
0 commit comments