CITAHub Docs
CITAHub Docs
Visit the documentation site:Update documents
- Add or modify the docs under
docs
folder. - Modify sidebar in
sidebars.json
Build the documentation site
Initializing the website
$ cd website
$ yarn install
Note
You can also install by npm:
$ npm install
Update Sidebar Titles
$ cd website && yarn run write-translations
Update Latest Docs in Crowdin
Crowdin-CLI Required - Crowdin-CLI
Crowdin Config Required - set project identifier and apikey in
crowdin.yaml
- Upload latest docs to crowdin
$ yarn run crowdin:upload
- Download latest translated docs from crowdin
$ yarn run crowdin:download
Deploy to Github Pages
$ cd website && GIT_USER=<your_git_username> CURRENT_BRANCH=master USER_SSH=true yarn run publish-gh-pages