Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Add README for contributing to docs #35

Merged
merged 1 commit into from
Dec 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```