- Clone the repository
cdinto thewebsitedirectory.- Run
yarn(ornpm install) yarn start
- The
docsdirectory 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_IDandCROWDIN_DOCUSAURUS_API_KEYenvironment variables (ask @brentvatne if you need access). cd websiteand runyarn crowdin-uploadand 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 source branch:
GIT_USER=your_github_username \
STABLE_RELEASE=true \
CURRENT_BRANCH=your_branch_name \
USE_SSH=true \
yarn run publish-gh-pagesGIT_USER=your_github_username \
CURRENT_BRANCH=your_branch_name \
USE_SSH=true \
yarn run publish-gh-pages