mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
5470fda3fe
* Add Migration Guide to docs * edit: replace astro.config.js with astro.config.mjs * edit: use plain object in define:vars example * edit: improve 'components in markdown' documentation * edit: use astro resolve in file reference documentation example * edit: rename 'writing plugins' heading to 'custom renderers' Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com> * edit: fix PUBLIC_ environment variable example * edit: fix define:vars variable in example * edit: remove top-level alias documentation * edit: cleanup "passing variables into scripts and styles" description * Update migration-guide.md * Update migration-guide.md * update deployment config * update configuration * fix some errors and write a commit message about it * move the migration guide * update documentation * add migration guide to sidebar Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com> Co-authored-by: Fred K. Schott <fkschott@gmail.com> |
||
---|---|---|
.. | ||
public | ||
reference | ||
src | ||
.nvmrc | ||
.prettierignore | ||
.prettierrc | ||
.stackblitzrc | ||
astro.config.mjs | ||
CHANGELOG.md | ||
jsconfig.json | ||
package.json | ||
README.md | ||
vercel.json |
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/Fork the project
- This project uses yarn to manage dependencies. Make sure that you have yarn v1 installed.
- 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.
The environment variable SNOWPACK_PUBLIC_GITHUB_TOKEN
must be set to a personal access token with public_repo
permissions to prevent rate-limiting.