This website is built using Docusaurus, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Make sure the english json translation files are generated. In the documentation directory run:
npm run write-translations
From the main project directory run:
python .\translate_docs.py
Note that this step is very slow, it translates all of the pages, documentation files, and json message files into 29 additional languages.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
or on Windows (and using npm):
cmd /C 'set "GIT_USER=<Your GitHub username>" && npm run deploy'
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
In order to have consistent anchor links across languages (and so be able to have links within the text), header ids were generated using:
npm run write-heading-ids
You can also manually add header ids.