This website is built using Docusaurus 2, a modern static website generator. We've settled on using npm as our package manager - please make sure you use that instead of yarn.
Current versions of node confirmed working:
- 18.12.1 (Windows via
nvm for Windows)
npm i
After you've checked out the repo (and whenever you pull in new changes) you should run this command to install any new packages.
npm start
This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Config changes (e.g. changes to docusaurus.config.js and similar) may require you to restart the npm task.
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Whenever the main branch is updated, it will trigger the Deploy to GitHub Pages workflow, which will automatically build the site and update the deployment.