Every pull request needs to be reviewed by another contributor to help with the overall quality of the documentation.
-
Clone the Project
git clone git@github.com:withastro/docs.git -
Run
yarn installto install latest dependencies.This project uses yarn to manage dependencies. Make sure that you have yarn v1 installed.
-
Run
yarn workspace docs devto start the dev server. -
Run
yarn workspace docs buildto build the final site for production.The environment variable
SNOWPACK_PUBLIC_GITHUB_TOKENmust be set to a personal access token withpublic_repopermissions to prevent rate-limiting.
The site is automatically deployed when commits land in latest, via Netlify.
The "next" docs are automatically deployed when commits land in main, via Netlify at https://main--astro-docs-2.netlify.app/getting-started/.