astro/docs
Jonathan Neal 5470fda3fe
Add Migration Guide to docs (#1751)
* 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>
2021-11-12 07:40:49 -05:00
..
public Allow inline code blocks to wrap lines (#1799) 2021-11-11 12:30:09 -07:00
reference Expose slots to components (#1368) 2021-09-15 11:27:59 -04:00
src Add Migration Guide to docs (#1751) 2021-11-12 07:40:49 -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 Add Migration Guide to docs (#1751) 2021-11-12 07:40:49 -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 Add Migration Guide to docs (#1751) 2021-11-12 07:40:49 -05:00
README.md add dev script, switch documentation from advising start to dev script (#1141) 2021-08-18 22:07:08 -07:00
vercel.json Docs site cleanup (#948) 2021-07-30 22:39:15 -07:00

Astro Docs Astro logo

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.