Mermint Markdown Workflow

Use this workflow to render Markdown Mermaid blocks into GitHub-friendly <picture> markup and SVG assets. Prefer running mermint directly from this GitHub repo with npx; do not assume a local checkout or global install. For hand-drawn or architecture-beta work, do not stop at a successful SVG render. Rasterize previews, inspect them visually, and iterate until readability and aesthetics are acceptable in both themes.

Inputs To Confirm

• Target markdown file (example: README.md)
• SVG output directory (example: svgs)
• In-place overwrite vs separate output path
• Whether Mermaid source must be preserved (--keep-mermaid)
• Whether hand-drawn tuning is allowed, or whether the user wants the existing style preserved

Preflight Checks

Before rendering, check:

• node is installed and version >= 22