- Clone the repository
cd
into thewebsite
directory.- Run
yarn
(ornpm install
) yarn start
- The
docs
directory contains the markdown files used to generate the website. Change them and refresh the page when running the documentation locally and you will see the changes reflected. - If you want to add a new page, you need to add it to sidebars.json and then restart the server.
- Configure
CROWDIN_DOCUSAURUS_PROJECT_ID
andCROWDIN_DOCUSAURUS_API_KEY
environment variables (ask @brentvatne if you need access). cd website
and runyarn crowdin-upload
and thenyarn crowdin-download
Before deploying, be sure to download the latest translations!
Only collaborators on this repository can deploy. cd
into the website directory and run the following command from the 2.x
branch:
GIT_USER=your_github_username \
STABLE_RELEASE=true \
CURRENT_BRANCH=your_branch_name \
USE_SSH=true \
yarn run publish-gh-pages
GIT_USER=your_github_username \
CURRENT_BRANCH=your_branch_name \
USE_SSH=true \
yarn run publish-gh-pages