reportist/README.md

18 lines
742 B
Markdown

# Report plugin and shared visual elements
`render.sh` renders authored YAML or JSON with `plugins/report/render.typ` and
`plugins/report/model.typ`. Report structure belongs to that plugin. It reads
named palettes from `visual/themes.yaml` and imports visual functions from
`visual/elements.typ`.
```bash
./render.sh examples/example-report.yaml --output report.pdf
```
The diagnostic plugin in the Reports repository imports the same visual module
but has its own input format, analysis, layout, and launch script. Rendering a
diagnostic does not pass through the report document model or schema.
`tools/render-all.sh` renders a directory of authored reports.
`tools/export-json-all.sh` serializes YAML reports to JSON for publication.