Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.02 KB

README.md

File metadata and controls

31 lines (18 loc) · 1.02 KB
Raw

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

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.