Home

RayoMD documentation

RayoMD is a tiny native Markdown-to-PDF converter focused on fast startup, small packaged binaries, and predictable deployment. Its native renderer writes PDF bytes directly from C++17 without requiring a browser, Pandoc, or LaTeX.

Start here

• Getting Started — install, build, and make a first PDF
• CLI Reference — export, batch, stdin, serve, and benchmark modes
• Native Markdown Support — the supported subset and its boundaries
• C++ API
• C++ API — embed the native exporter
• Reversible PDFs — opt-in exact Markdown recovery
• Benchmarks — dated results, methodology, and reproduction notes
• Performance Watcher — check a change for regressions
• Brand Assets — mascot and icon contribution guidance

The main repository remains authoritative for source code, release files, build scripts, CI fixtures, and version-specific benchmark records. This wiki contains the longer user and engineering guides.

Choosing an engine

Use native RayoMD when the document is simple, speed matters, and the package must remain small. Use Pandoc, a browser renderer, or LaTeX when you need full CommonMark/Pandoc extensions, TeX math, templates, filters, citations, or HTML/CSS fidelity.

RayoMD's native renderer is intentionally a fast Markdown subset, not a Pandoc clone.