···1+# Starlight Starter Kit: Basics
2+3+[](https://starlight.astro.build)
4+5+```
6+pnpm 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+18+Inside of your Astro + Starlight project, you'll see the following folders and
19+files:
20+21+```
22+.
23+├── public/
24+├── src/
25+│ ├── assets/
26+│ ├── content/
27+│ │ ├── docs/
28+│ └── content.config.ts
29+├── astro.config.mjs
30+├── package.json
31+└── tsconfig.json
32+```
33+34+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory.
35+Each file is exposed as a route based on its file name.
36+37+Images can be added to `src/assets/` and embedded in Markdown with a relative
38+link.
39+40+Static assets, like favicons, can be placed in the `public/` directory.
41+42+## 🧞 Commands
43+44+All commands are run from the root of the project, from a terminal:
45+46+| Command | Action |
47+| :--------------------- | :----------------------------------------------- |
48+| `pnpm install` | Installs dependencies |
49+| `pnpm dev` | Starts local dev server at `localhost:4321` |
50+| `pnpm build` | Build your production site to `./dist/` |
51+| `pnpm preview` | Preview your build locally, before deploying |
52+| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
53+| `pnpm astro -- --help` | Get help using the Astro CLI |
54+55+## 👀 Want to learn more?
56+57+Check out [Starlight’s docs](https://starlight.astro.build/), read
58+[the Astro documentation](https://docs.astro.build), or jump into the
59+[Astro Discord server](https://astro.build/chat).
···1+---
2+title: Example Guide
3+description: A guide in my new Starlight docs site.
4+---
5+6+Guides lead a user through a specific task they want to accomplish, often with a
7+sequence of steps. Writing a good guide requires thinking about what your users
8+are trying to do.
9+10+## Further reading
11+12+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis
13+ framework
···1+---
2+title: Getting Started with Streamplace Development
3+description: Learn how to set up your development environment for Streamplace.
4+---
5+6+So, you've decided to contribute to Streamplace development. Here's how you can
7+get started:
8+9+## Prerequisites
10+11+- [Node.js](https://nodejs.org/)
12+- [Yarn](https://yarnpkg.com/)
13+ - A way to install it is with `pnpm/npm install -g yarn`. No corepack in this
14+ repo _just_ yet.
15+- Go (version 1.23)
16+ ([We're blocked on going to Go 1.24](https://github.com/NordSecurity/uniffi-bindgen-go/issues/66).)
17+ - If you use `mise`, you can install latest Go 1.23 with
18+ `mise install go@prefix:1.23`
19+- Meson
20+- Ninja
21+22+### For development only
23+24+- pkg-config
25+26+## Get Started
27+28+1. Install prereqs
29+2. Download JS packages with `yarn`
30+3. `make dev-setup`
31+4. `make dev`
32+5. launch via `./build-<platform>-<arch>/streamplace`
+38
js/docs/src/content/docs/index.mdx
···00000000000000000000000000000000000000
···1+---
2+title: Welcome to Streamplace!
3+description: Begin your development journey with the Streamplace documentation.
4+template: splash
5+hero:
6+ tagline: Solve live video for your project with Streamplace.
7+ image:
8+ file: ../../assets/cube.png
9+ alt: Streamplace logo. A pink 3d box viewed from a top corner.
10+ actions:
11+ - text: Get Started
12+ link: /guides/getting-started/
13+ icon: right-arrow
14+ - text: Visit Streamplace
15+ link: https://stream.place
16+ icon: external
17+ variant: minimal
18+---
19+20+import { Card, CardGrid } from "@astrojs/starlight/components";
21+22+## Next Steps
23+24+<CardGrid stagger>
25+ <Card title="Update Content" icon="pencil">
26+ Modify `src/content/docs/index.mdx` to reflect your changes.
27+ </Card>
28+ <Card title="Add New Pages" icon="add-document">
29+ Introduce new Markdown or MDX files in `src/content/docs` to expand your
30+ documentation.
31+ </Card>
32+ <Card title="Configure Your Site" icon="setting">
33+ Adjust your `sidebar` and other configurations in `astro.config.mjs`.
34+ </Card>
35+ <Card title="Read the Docs" icon="open-book">
36+ Dive deeper into [stream.place Documentation](https://stream.place/docs).
37+ </Card>
38+</CardGrid>
···1+---
2+title: Example Reference
3+description: A reference page in my new Starlight docs site.
4+---
5+6+Reference pages are ideal for outlining how things work in terse and clear
7+terms. Less concerned with telling a story or addressing a specific use case,
8+they should give a comprehensive outline of what you're documenting.
9+10+## Further reading
11+12+- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis
13+ framework