This website is built using Docusaurus 3, a modern static website generator.
This deploys through github actions!
npm install(only initially needed)npm start
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
TBD
- Documentation is written as a markdown file. Contributions are done via pull request
- We use markdownlint in a pre-commit hook.
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.