mermint-markdown-workflow

What problem does it solve?

Converts Mermaid code blocks embedded in Markdown into GitHub-style picture markup and paired light/dark SVG assets, enabling safe, idempotent README diagram updates and reliable visual QA without destroying source blocks.

Core Features & Use Cases

• README-style rendering: Produces <picture> markup with light and dark SVG variants suitable for GitHub and README consumption.
• Source preservation: Supports non-destructive conversion with preserved Mermaid source blocks (keep-mermaid) for traceability and future edits.
• Visual QA workflow: Rasterizes light/dark SVGs to PNG previews, provides a quality rubric, and prescribes an iterative Rough.js tuning loop for hand-drawn or architecture-beta diagrams.
• AWS architecture guardrails: Includes guidance and a reference for built-in AWS icon names to produce clearer architecture-beta diagrams.
• Automation & CI: Describes non-interactive, in-place, and non-destructive preview modes and preflight checks to run reliably in CI environments.

Quick Start

Use the mermint-markdown-workflow to convert README.md Mermaid blocks into picture markup and paired light/dark SVG assets while preserving source blocks and generating PNG previews for visual QA.