aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
blob: 623b6ede3e200b46d41c2d889fd2cc3ee99bc074 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Astro Docs <img width="19.2" height="25.6" src="https://raw.githubusercontent.com/snowpackjs/astro/main/assets/brand/logo.svg" alt="Astro logo">

## Contributing

### Pull Requests

Every pull request needs to be reviewed by another contributor to the documentation to help with the overall quality of the documentation.

## Running this project

- Clone/Fork the project
- This project uses yarn to manage dependencies. [Make sure that you have yarn v1 installed.](https://classic.yarnpkg.com/)
- Run `yarn install` to install latest dependencies.
- Run `yarn dev` to start the dev server.
- Run `yarn build` to build the final site for production.

The environment variable `SNOWPACK_PUBLIC_GITHUB_TOKEN` must be set to a personal access token with `public_repo` permissions to prevent rate-limiting.