Skip to content

Commit f137ad3

Browse files
committed
update readme for contributing to docs
1 parent d9afa0a commit f137ad3

1 file changed

Lines changed: 10 additions & 40 deletions

File tree

docs/README.md

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,19 @@
1-
# Starlight Starter Kit: Basics
1+
# BDT Docs
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
How to contribute to the docs
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
5+
## Setup
86

9-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
`cd docs/`
108

11-
## 🚀 Project Structure
9+
`npm install`
1210

13-
Inside of your Astro + Starlight project, you'll see the following folders and files:
11+
`npm run dev`
1412

15-
```
16-
.
17-
├── public/
18-
├── src/
19-
│ ├── assets/
20-
│ ├── content/
21-
│ │ └── docs/
22-
│ └── content.config.ts
23-
├── astro.config.mjs
24-
├── package.json
25-
└── tsconfig.json
26-
```
13+
## Docs Pages
2714

28-
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.
15+
Each page in the docs is a markdown file located at content/docs/...
2916

30-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
17+
To edit a docs page, simply edit the markdown file.
3118

32-
Static assets, like favicons, can be placed in the `public/` directory.
33-
34-
## 🧞 Commands
35-
36-
All commands are run from the root of the project, from a terminal:
37-
38-
| Command | Action |
39-
| :------------------------ | :----------------------------------------------- |
40-
| `npm install` | Installs dependencies |
41-
| `npm run dev` | Starts local dev server at `localhost:4321` |
42-
| `npm run build` | Build your production site to `./dist/` |
43-
| `npm run preview` | Preview your build locally, before deploying |
44-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
45-
| `npm run astro -- --help` | Get help using the Astro CLI |
46-
47-
## 👀 Want to learn more?
48-
49-
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).
19+
To add a docs page, add a markdown file in the appropriate directory (`user/` for user-facing pages or `dev/` for developer-facing pages). The file must include [frontmatter](https://www.markdownlang.com/advanced/frontmatter.html) with `title` and `description` fields. In `astro.config.mjs`, add an item to the sidebar in the appropriate location to add your page to the sidebar.

0 commit comments

Comments
 (0)