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.
- Deploying to GitHub Pages occurs automatically upon merges to
main
. - Check the list of all
Deploy to GitHub Pages
workflow runs to ensure your changes are successfully deployed after they're merged.