Website

This website is built using Docusaurus 3, a modern static website generator.

How to deploy

This deploys through github actions!

How to use locally

• npm install (only initially needed)
• npm start

Verify build before pushing remote

If there are any issues with wrong/outdated links, the github action will fail. To reduce the feedback loop, build it locally before pushing.

npm run build

Dependency security overrides

package.json overrides pin patched transitive dependencies where upstream ranges still select vulnerable versions: js-yaml in markdownlint-cli, qs, serialize-javascript, and uuid in sockjs. Recheck these overrides when updating their parent packages and remove them once upstream ranges include the fixes.

How to use the documentation repository

TBD

• Documentation is written as a markdown file. Contributions are done via pull request
• We use markdownlint in a pre-commit hook.

How to configure markdown rules

https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md Rules are configured in a file named .markdownlint.json for more detailed rules have a look at this site as an example.