openrport

About documentation

The documentation system is based on Hugo and the Geekdocs Theme

Write

Use markdown with the shortcodes from Geekdocs.

Start a local Hugo server to get a live preview of your changes

cd docs
hugo server

Check

Before pushing, check your file with markdownlint-cli

npx markdownlint-cli content/