Alex Lebens
774eb707a3
All checks were successful
release-image / build (push) Successful in 31s
release-image / guarddog (push) Successful in 1m2s
release-image / semantic-release (push) Successful in 28s
release-image / release-harbor (push) Has been skipped
release-image / release-gitea (push) Has been skipped
Reviewed-on: #188
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# Starlight
|
|
|
|
[](https://starlight.astro.build)
|
|
|
|
```
|
|
pnpm create astro@latest -- --template starlight
|
|
```
|
|
|
|
## 🚀 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 |
|
|
| :--------------------- | :----------------------------------------------- |
|
|
| `bun install` | Installs dependencies |
|
|
| `bun run dev` | Starts local dev server at `localhost:4321` |
|
|
| `bun run build` | Build your production site to `./dist/` |
|