-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
83dd9e6
commit c97251b
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |