Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Mermaid Processor

Purpose

Converts Mermaid diagram files to PNG, SVG, or PDF using mmdc (mermaid-cli).

How It Works

Discovers .mmd files in the project and runs mmdc on each file, generating output in the configured formats. Each format produces a separate output file.

Source Files

  • Input: **/*.mmd
  • Output: out/mermaid/{format}/{relative_path}.{format}

Configuration

[processor.mermaid]
mmdc_bin = "mmdc"                      # The mmdc command to run
formats = ["png"]                      # Output formats (png, svg, pdf)
args = []                              # Additional arguments to pass to mmdc
output_dir = "out/mermaid"             # Output directory
extra_inputs = []                      # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
mmdc_binstring"mmdc"The mermaid-cli executable to run
formatsstring[]["png"]Output formats to generate (png, svg, pdf)
argsstring[][]Extra arguments passed to mmdc
output_dirstring"out/mermaid"Base output directory
extra_inputsstring[][]Extra files whose changes trigger rebuilds