Generic Typst-based report renderer. Turns structured YAML/JSON reports into sober, reproducible PDF documents.
Go to file
Dandaedre 7d428f71d9
Reportist CI Both renderer plugin suites passed.
Beffroi/reportist/pipeline/head This commit looks good Details
Add color-only Ravenous palettes to shared themes
2026-09-17 00:15:07 +02:00
docs Add color-only Ravenous palettes to shared themes 2026-09-17 00:15:07 +02:00
examples Separate report renderer and share visual elements 2026-09-16 20:08:11 +02:00
plugins Add color-only Ravenous palettes to shared themes 2026-09-17 00:15:07 +02:00
tests Add color-only Ravenous palettes to shared themes 2026-09-17 00:15:07 +02:00
tools Format Reportist shell entry points consistently 2026-09-16 21:07:18 +02:00
visual Add color-only Ravenous palettes to shared themes 2026-09-17 00:15:07 +02:00
.gitignore feat: define generic report v1 contract and YAML JSON validator 2026-09-15 16:32:36 +02:00
AGENTS.md Document Reportist plugin contract and agent guidance 2026-09-17 00:10:54 +02:00
Jenkinsfile Own report and diagnostic plugins behind one build CLI 2026-09-16 21:03:17 +02:00
LICENSE Initial commit 2026-09-15 14:49:58 +02:00
README.md Add color-only Ravenous palettes to shared themes 2026-09-17 00:15:07 +02:00
build.sh Format Reportist shell entry points consistently 2026-09-16 21:07:18 +02:00
render.sh Format Reportist shell entry points consistently 2026-09-16 21:07:18 +02:00

README.md

Reportist

Reportist is the standalone Typst engine for authored reports and raw WinDiagnostics captures. Each plugin owns its input interpretation and document layout. Plugins share graphical elements and themes in visual/.

./build.sh render report examples/example-report.yaml --output report.pdf
./build.sh render diagnostic plugins/diagnostics/tests/fixtures/legacy/windiagnostics-v1.json --output diagnostic.pdf
./tests/test.sh

The public CLI also renders source directories, analyzes diagnostic evidence, validates inputs, and exports authored YAML as JSON. See the CLI contract for commands and output behavior, the plugin guide to add a renderer, and the authored report contract for report input. The palette catalog lists the themes available to both plugins. The AGENTS.md file is a short implementation manifest for coding agents.