js/docs/README.md at v0.7.21 · stream.place/streamplace

stream.place / streamplace
Live video on the AT Protocol
streamplace / js / docs / README.md
at v0.7.21 59 lines 2.6 kB view raw view rendered
 1# Starlight Starter Kit: Basics
 2
 3[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
 4
 5```
 6pnpm create astro@latest -- --template starlight
 7```
 8
 9[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12[![Deploy with Vercel](https://vercel.com/button)](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
19files:
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
34Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory.
35Each file is exposed as a route based on its file name.
36
37Images can be added to `src/assets/` and embedded in Markdown with a relative
38link.
39
40Static assets, like favicons, can be placed in the `public/` directory.
41
42## 🧞 Commands
43
44All 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
57Check 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).