Skip to content

Commit

Permalink
docs: add README for contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinanielsen committed Dec 19, 2023
1 parent 83dd9e6 commit c97251b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Go-fast CDN Documentation

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/).

## Development

The docs are built with [Starlight](https://starlight.astro.build/), an extension to [Astro](https://astro.build/).

### Installation

Use you favorite node package manager. We recommend pnpm, but others can be used as well.
```bash
pnpm install #installs the dependencies
```

### Developing

```bash
pnpm dev # runs the docs site in development mode on localhost
```

### Building

```bash
pnpm build #builds the site
```

0 comments on commit c97251b

Please sign in to comment.