Getting Started

Getting Started

Download a packaged binary from the RayoMD releases, or build it from source.

Windows app

1. Run rayomd.exe.
2. Write or paste Markdown, or drag a .md file into the window.
3. Choose the native engine or optional Pandoc mode.
4. Choose a style and margin.
5. Export with the button or Ctrl+E.
6. Enable URL images only when the document should fetch remote resources.

Windows build

Requirements: MinGW-w64 with C++17 support, CMake, and the Windows SDK/DirectX 11 libraries.

cmake -S . -B build/windows -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
cmake --build build/windows --config Release

The output is build/windows/rayomd.exe.

Linux and WSL build

Requirements: a C++17 compiler, CMake, and a system TrueType font such as DejaVu Sans. zlib headers optionally enable PNG alpha support.

sudo apt-get update
sudo apt-get install -y g++ cmake fonts-dejavu-core zlib1g-dev
cmake -S . -B build/linux -DCMAKE_BUILD_TYPE=Release
cmake --build build/linux --config Release

The output is build/linux/rayomd.

The default Linux build avoids a libcurl runtime dependency. To enable remote HTTP/HTTPS images, install its development headers and build with:

cmake -S . -B build/linux-curl -DCMAKE_BUILD_TYPE=Release -DRAYOMD_USE_CURL=ON
cmake --build build/linux-curl --config Release

Verify a Linux build with:

python3 tests/verify_cli.py --binary build/linux/rayomd

First CLI export

./rayomd --doctor
./rayomd --export input.md output.pdf

Windows uses the same syntax with rayomd.exe. Defaults are native, elegant, and normal. See CLI Reference for the remaining modes.