Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
website
.dockerignore
.editorconfig
.gitignore
.gitmodules
Dockerfile
LICENSE
README.md
UserGuide.md
crowdin.yaml.example
docker-compose.yml
package.json

README.md

CITAHub Docs

Visit the documentation site: CITAHub Docs

Update documents

  • Add or modify the docs under docs folder.
  • Modify sidebar in sidebars.json

Host Locally

$ cd website
$ yarn install
$ ENABLE_SOURCE_DOCS=true yarn start # use set ENABLE_SOURCE_DOCS to set the environment

Open your brower, and enter the http://localhost:3000/en/next/welcome

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

  1. Upload latest docs to crowdin
$ yarn run crowdin:upload
  1. Download latest translated docs from crowdin
$ yarn run crowdin:download

Deploy to Github Pages

$ cd website && GIT_USER=<your_git_username> CURRENT_BRANCH=master USE_SSH=true yarn run publish-gh-pages
You can’t perform that action at this time.