.. | ||
public | ||
reference | ||
src | ||
.nvmrc | ||
.prettierignore | ||
.prettierrc | ||
.stackblitzrc | ||
astro.config.mjs | ||
CHANGELOG.md | ||
jsconfig.json | ||
package.json | ||
README.md |
Astro Docs
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
-
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 withpublic_repo
permissions to prevent rate-limiting.
Deploying
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/.