reportist/docs/report-contract.md

594 B

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 listed in the palette guide; a custom theme dictionary can also 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.