a8494a91d4
* add logos for github dark mode * Hot fix (gh-*-mode-only) issue "that's an issue with wrapping an image in a link. We are currently still looking into how to best solve this. However, you can do the following which should work." - dipree * delete <td> 'cuz it was duplicate * [ci] yarn format * remove unnecessary code tag Co-authored-by: X7md <X7md@users.noreply.github.com> |
||
---|---|---|
.. | ||
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
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 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/.