mmdflux

Render Mermaid diagrams as Unicode text, ASCII, SVG, or MMDS JSON.

mmdflux is built for terminal-first diagram workflows: quick local rendering, linting, and machine-readable graph output for tooling.

Install

Homebrew (recommended)

brew tap kevinswiber/mmdflux
brew install mmdflux

Cargo

cargo install mmdflux

Prebuilt binaries

Download platform binaries from GitHub Releases.

Quick Start

# Render a Mermaid file to text (default format)
mmdflux diagram.mmd

# Read Mermaid from stdin
printf 'graph LR\nA-->B\n' | mmdflux

# ASCII output
mmdflux --format ascii diagram.mmd

# SVG output (flowchart only)
mmdflux --format svg diagram.mmd -o diagram.svg

# MMDS JSON output
mmdflux --format mmds diagram.mmd

# Lint mode (validate input and print diagnostics)
mmdflux --lint diagram.mmd

What It Supports

• Flowchart rendering in text/ASCII/SVG/MMDS
• Class diagram rendering in text/ASCII/SVG/MMDS
• Mermaid-to-MMDS and MMDS-to-Mermaid conversion
• Layout directions: TD, BT, LR, RL
• Edge styles: solid, dotted, thick, invisible, cross-arrow, circle-arrow

Documentation

• CLI reference
• Class diagram support matrix
• MMDS specification
• MMDS JSON schema
• Gallery
• Library usage
• Architecture
• Debugging and parity tools
• Releasing
• WASM build/test commands

License

MIT