astro/docs/README.md

25 lines
1 KiB
Markdown
Raw Normal View History

2021-11-23 22:47:05 +00:00
# Astro Docs <img width="19.2" height="25.6" src="https://raw.githubusercontent.com/withastro/astro/main/assets/brand/logo.svg" alt="Astro logo">
2021-07-15 18:13:35 +00:00
## 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 the Project
`git clone git@github.com:withastro/astro.git`
2022-01-18 22:15:25 +00:00
- Run `pnpm install` to install latest dependencies.
> This project uses pnpm to manage dependencies.
- Run `pnpm run dev --filter docs` to start the dev server.
- Run `pnpm run build --filter docs` 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.
2021-07-15 18:13:35 +00:00
The "next" docs are automatically deployed when commits land in `main`, via Netlify at <https://main--astro-docs-2.netlify.app/getting-started/>.