History

Marty Nelson 46085e6d8c update pages config doc description (#2478 )		2022-01-27 17:45:01 -05:00
..
public	Use smooth scrolling with reduced motion has no preference (#2355 )	2022-01-10 22:44:17 -05:00
reference	docs: update some Snowpack references to Vite (#2035 )	2021-11-29 13:39:38 -07:00
src	update pages config doc description (#2478 )	2022-01-27 17:45:01 -05:00
.nvmrc	Add Migration Guide to docs (#1751 )	2021-11-12 07:40:49 -05:00
.prettierignore	merge in docs site (#705 )	2021-07-15 14:13:35 -04:00
.prettierrc	[ci] yarn format	2021-07-20 04:07:49 +00:00
.stackblitzrc	Add Migration Guide to docs (#1751 )	2021-11-12 07:40:49 -05:00
astro.config.mjs	Use accessible indentation (#2253 )	2021-12-22 16:11:05 -05:00
CHANGELOG.md	Version Packages (#1358 )	2021-09-14 17:22:50 -07:00
jsconfig.json	Add Migration Guide to docs (#1751 )	2021-11-12 07:40:49 -05:00
package.json	Restore accessibility check on docs site (#2362 )	2022-01-11 15:39:19 -05:00
README.md	Update instructions for the monorepo (#2274 )	2022-01-10 15:04:08 -05:00

Astro Docs

Contributing

Every pull request needs to be reviewed by another contributor to the documentation to help with the overall quality of the documentation.

Clone the Project

git clone git@github.com:withastro/astro.git
Run yarn install to install latest dependencies.

This project uses yarn to manage dependencies. Make sure that you have yarn v1 installed.
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.

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/.