markdown-diagrams 1.0.0

Extract and render Mermaid diagrams from Markdown files

markdown-diagrams

Extract and render Mermaid diagrams from Markdown files to PNG, SVG, and PDF.

Features

• Extract Mermaid diagrams from any Markdown file
• Render diagrams to PNG, SVG, and PDF formats
• Automatically name output files based on bold-text titles or document headings
• Support for 19 diagram types (flowchart, sequence, ER, class, state, gantt, and more)
• Extensible architecture for additional diagram types

Prerequisites

Rendering requires the Mermaid CLI:

npm install -g @mermaid-js/mermaid-cli

Installation

From PyPI

pip install markdown-diagrams

From source

git clone https://github.com/bryankemp/markdown-diagrams.git
cd markdown-diagrams
pip install -e .

Usage

Extract and render all diagrams

markdown-diagrams extract document.md

Specify an output directory

markdown-diagrams extract document.md -o ./output

Filter by diagram type

markdown-diagrams extract document.md -t mermaid -t flowchart

Choose an output format

# PNG (default)
markdown-diagrams extract document.md -f png

# SVG
markdown-diagrams extract document.md -f svg

# PDF
markdown-diagrams extract document.md -f pdf

Custom dimensions and theme

markdown-diagrams extract document.md -w 1000 -H 800 -T dark

Validate diagrams

# Check all diagrams for syntax errors
markdown-diagrams validate document.md

# Auto-fix common issues (whitespace, unquoted labels)
markdown-diagrams validate document.md --fix

# Preview fixes without writing
markdown-diagrams validate document.md --dry-run

Supported Diagram Types

mermaid · flowchart · sequence · graph · gantt · pie · mindmap · quadrantDiagram · er · class · state · journey · gitGraph · userJourney · requirement · c4 · entityRelationship · component · active

Filename strategy

When a bold-text title (e.g. **Flowchart – License Injection**) appears directly above a code fence, it is used as the output filename. Otherwise the nearest #-heading is used. This means documents that follow the common pattern of a generic ### Diagrams heading with descriptive bold titles per diagram will get meaningful filenames automatically.

Python API

from markdown_diagrams import extract_diagrams, render_mermaid_diagram
from pathlib import Path

# Extract diagrams
diagrams = extract_diagrams(Path("document.md"))
for diagram_type, items in diagrams.items():
    for item in items:
        print(f"[{diagram_type}] {item['heading']}: {len(item['content'])} chars")

# Render a single diagram
render_mermaid_diagram(items[0]["content"], output_dir="./output")

Examples

See examples/all_diagram_types.md for a complete reference with every supported diagram type.

Development

pip install -e ".[dev]"
pytest
black --check .
ruff check .

Documentation

Full documentation is available at markdown-diagrams.readthedocs.io.

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

BSD 3-Clause License — see LICENSE for details.