Skip to content

Commit 16d2712

Browse files
docs: add README for contributing (#35)
1 parent 83dd9e6 commit 16d2712

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Go-fast CDN Documentation
2+
3+
This is the documentation for the Go-fast CDN. If you want to edit the docs, you can checkout the [contribution guide](https://kevinanielsen.github.io/go-fast-cdn/contribution/contributing/).
4+
5+
## Development
6+
7+
The docs are built with [Starlight](https://starlight.astro.build/), an extension to [Astro](https://astro.build/).
8+
9+
### Installation
10+
11+
Use you favorite node package manager. We recommend pnpm, but others can be used as well.
12+
```bash
13+
pnpm install #installs the dependencies
14+
```
15+
16+
### Developing
17+
18+
```bash
19+
pnpm dev # runs the docs site in development mode on localhost
20+
```
21+
22+
### Building
23+
24+
```bash
25+
pnpm build #builds the site
26+
```

0 commit comments

Comments
 (0)