reportist/docs/report-contract.md

12 lines
570 B
Markdown

# Authored report input
The report plugin accepts YAML or JSON dictionaries. `metadata.Date` and
`metadata.Author` are required. The document model supports report-specific
fields such as `diagnostics` as well as ordinary sections, findings, actions,
and appendices. Named themes are `default`, `cic`, and `eridani`; a custom theme
dictionary can be provided. The renderer is `plugins/report/`.
The diagnostic plugin has a separate raw WinDiagnostics input and its own Typst
document model. Both plugins import `reporter/visual/elements.typ` for graphical
primitives.