Skip to content

Batch Conversion

Milosz edited this page Oct 19, 2026 · 3 revisions

Batch Conversion

--batch converts every .md file of a folder on several threads; --stdin-batch and --serve read Markdown paths from standard input.

rayomd --batch docs pdf-out modern normal --workers=8
rayomd --batch docs pdf-out --recursive --skip-unchanged --report=report.jsonl
Flag Effect
--workers=N 1 to 64 worker threads; automatic mode uses one per CPU the process may run on (its affinity: taskset, a container's CPU set), at most 6
--recursive (since 3.2) Also converts subfolders, mirrored in the output folder
--skip-unchanged (since 3.2) Keeps a PDF that is newer than its Markdown file
--report=FILE (since 3.2) One JSON line per document; - writes to standard output

Every other export flag (style, margin, --page-size, --compress, --theme, --pdfa, --pdfua, ...) applies to each document.

Report lines

{"input":"docs/guide.md","output":"out/guide.pdf","status":"ok","code":0,"pages":1,"bytes":1791,"ms":0.165,"missing_characters":0,"failed_images":0}
{"input":"docs/sub/page.md","output":"out/sub/page.pdf","status":"ok","code":0,"pages":1,"bytes":1308,"ms":0.153,"missing_characters":0,"failed_images":1}
{"input":"docs/guide.md","output":"out/guide.pdf","status":"skipped","code":0,"pages":0,"bytes":1791,"ms":0.000,"missing_characters":0,"failed_images":0}

The first two lines come from rayomd --batch docs out --recursive --report=-, the third from the same run again with --skip-unchanged.

Field Meaning
status ok, skipped (unchanged, with --skip-unchanged) or error
code The exit code this document alone would give (see CLI Reference)
error Why it failed, for error
pages, bytes, ms The PDF's pages and size, and the time its export took
missing_characters Characters no font found could show, drawn as their base letter or ?
failed_images Images shown as their alt text: missing, unreadable, refused by the image policy

The batch exits with 0 when every document succeeded, else with the code of a failed one.

Clone this wiki locally