We use Docusaurus within these docs.
- You can find a general set of guides to Docusaurus here.
- Docusaurus provides extra cool formatting features on top of vanilla Markdown, see the guide to these features here.
Install deps and run the dev server locally by running:
yarn
yarn start
Most changes are reflected live without having to restart the server.
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
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.