diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..5fd357fad --- /dev/null +++ b/docs/README.md @@ -0,0 +1,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 start` 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. |