diff options
| -rw-r--r-- | docs/README.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/README.md b/docs/README.md index e7154efe9..c99ef1ea9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,10 +8,17 @@ Every pull request needs to be reviewed by another contributor to the documentat ## 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/) +- Clone the Project + + `git clone git@github.com:withastro/astro.git` - 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. + > This project uses yarn to manage dependencies. [Make sure that you have yarn v1 installed.](https://classic.yarnpkg.com/) +- Run `yarn workspace docs dev` to start the dev server. +- Run `yarn workspace docs 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. + +## Deploying + +The site is automatically deployed when commits land in `latest`, via Netlify. -The environment variable `SNOWPACK_PUBLIC_GITHUB_TOKEN` must be set to a personal access token with `public_repo` permissions to prevent rate-limiting. +The "next" docs are automatically deployed when commits land in `main`, via Netlify at <https://main--astro-docs-2.netlify.app/getting-started/>. |