···11+# Starlight Starter Kit: Basics
22+33+[](https://starlight.astro.build)
44+55+```
66+pnpm create astro@latest -- --template starlight
77+```
88+99+[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
1010+[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
1111+[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
1212+[](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)
1313+1414+> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
1515+1616+## 🚀 Project Structure
1717+1818+Inside of your Astro + Starlight project, you'll see the following folders and
1919+files:
2020+2121+```
2222+.
2323+├── public/
2424+├── src/
2525+│ ├── assets/
2626+│ ├── content/
2727+│ │ ├── docs/
2828+│ └── content.config.ts
2929+├── astro.config.mjs
3030+├── package.json
3131+└── tsconfig.json
3232+```
3333+3434+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory.
3535+Each file is exposed as a route based on its file name.
3636+3737+Images can be added to `src/assets/` and embedded in Markdown with a relative
3838+link.
3939+4040+Static assets, like favicons, can be placed in the `public/` directory.
4141+4242+## 🧞 Commands
4343+4444+All commands are run from the root of the project, from a terminal:
4545+4646+| Command | Action |
4747+| :--------------------- | :----------------------------------------------- |
4848+| `pnpm install` | Installs dependencies |
4949+| `pnpm dev` | Starts local dev server at `localhost:4321` |
5050+| `pnpm build` | Build your production site to `./dist/` |
5151+| `pnpm preview` | Preview your build locally, before deploying |
5252+| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
5353+| `pnpm astro -- --help` | Get help using the Astro CLI |
5454+5555+## 👀 Want to learn more?
5656+5757+Check out [Starlight’s docs](https://starlight.astro.build/), read
5858+[the Astro documentation](https://docs.astro.build), or jump into the
5959+[Astro Discord server](https://astro.build/chat).
···11+---
22+title: Example Guide
33+description: A guide in my new Starlight docs site.
44+---
55+66+Guides lead a user through a specific task they want to accomplish, often with a
77+sequence of steps. Writing a good guide requires thinking about what your users
88+are trying to do.
99+1010+## Further reading
1111+1212+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis
1313+ framework
···11+---
22+title: Getting Started with Streamplace Development
33+description: Learn how to set up your development environment for Streamplace.
44+---
55+66+So, you've decided to contribute to Streamplace development. Here's how you can
77+get started:
88+99+## Prerequisites
1010+1111+- [Node.js](https://nodejs.org/)
1212+- [Yarn](https://yarnpkg.com/)
1313+ - A way to install it is with `pnpm/npm install -g yarn`. No corepack in this
1414+ repo _just_ yet.
1515+- Go (version 1.23)
1616+ ([We're blocked on going to Go 1.24](https://github.com/NordSecurity/uniffi-bindgen-go/issues/66).)
1717+ - If you use `mise`, you can install latest Go 1.23 with
1818+ `mise install go@prefix:1.23`
1919+- Meson
2020+- Ninja
2121+2222+### For development only
2323+2424+- pkg-config
2525+2626+## Get Started
2727+2828+1. Install prereqs
2929+2. Download JS packages with `yarn`
3030+3. `make dev-setup`
3131+4. `make dev`
3232+5. launch via `./build-<platform>-<arch>/streamplace`
+38
js/docs/src/content/docs/index.mdx
···11+---
22+title: Welcome to Streamplace!
33+description: Begin your development journey with the Streamplace documentation.
44+template: splash
55+hero:
66+ tagline: Solve live video for your project with Streamplace.
77+ image:
88+ file: ../../assets/cube.png
99+ alt: Streamplace logo. A pink 3d box viewed from a top corner.
1010+ actions:
1111+ - text: Get Started
1212+ link: /guides/getting-started/
1313+ icon: right-arrow
1414+ - text: Visit Streamplace
1515+ link: https://stream.place
1616+ icon: external
1717+ variant: minimal
1818+---
1919+2020+import { Card, CardGrid } from "@astrojs/starlight/components";
2121+2222+## Next Steps
2323+2424+<CardGrid stagger>
2525+ <Card title="Update Content" icon="pencil">
2626+ Modify `src/content/docs/index.mdx` to reflect your changes.
2727+ </Card>
2828+ <Card title="Add New Pages" icon="add-document">
2929+ Introduce new Markdown or MDX files in `src/content/docs` to expand your
3030+ documentation.
3131+ </Card>
3232+ <Card title="Configure Your Site" icon="setting">
3333+ Adjust your `sidebar` and other configurations in `astro.config.mjs`.
3434+ </Card>
3535+ <Card title="Read the Docs" icon="open-book">
3636+ Dive deeper into [stream.place Documentation](https://stream.place/docs).
3737+ </Card>
3838+</CardGrid>
···11+---
22+title: Example Reference
33+description: A reference page in my new Starlight docs site.
44+---
55+66+Reference pages are ideal for outlining how things work in terse and clear
77+terms. Less concerned with telling a story or addressing a specific use case,
88+they should give a comprehensive outline of what you're documenting.
99+1010+## Further reading
1111+1212+- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis
1313+ framework