Was macht mermaid-to-image?
Konvertiert Mermaid-Codeblöcke in Markdown-Dateien in PNG-Bilder mithilfe der mermaid.ink-API.
Funktionsweise
- Liest eine Markdown-Datei und erkennt alle mit ````mermaid` gekennzeichneten Codeblöcke ein.
- Sendet den Inhalt jedes Mermaid-Codeblocks an die
https://mermaid.ink/api-API, um ein PNG-Bild zu generieren. - Ersetzt den ursprünglichen Codeblock im Markdown durch einen Bildverweis, z. B.
.
Voraussetzungen
- cURL: Für API-Aufrufe erforderlich.
- JQ: Wird zur JSON-Verarbeitung verwendet, falls nötig.
- Bash 4.0+: Aufgrund der Verwendung von
readarrayund anderen Bash-Erweiterungen.
Verwendung
./mermaid-to-image.sh <markdown-datei.md>
Beispiel
Angenommen, Sie haben eine Datei dokumentation.md mit folgendem Inhalt:
# Flussdiagramm
```mermaid
graph TD
A[Start] --> B{Entscheidung}
B -->|Ja| C[Ende]
B -->|Nein| D[Wiederholen]
```
Führen Sie das Skript aus:
./mermaid-to-image.sh dokumentation.md
Die resultierende dokumentation.md wird dann wie folgt aussehen:
# Flussdiagramm
Optionen
-o, --output <verzeichnis>: Legt das Ausgabeverzeichnis für die generierten PNG-Dateien fest (Standard: aktuelles Verzeichnis).-h, --help: Zeigt diese Hilfe an.
Ausgabe
- Generierte PNG-Dateien werden im aktuellen Verzeichnis (oder im angegebenen Ausgabeverzeichnis) abgelegt.
- Die ursprüngliche Markdown-Datei wird direkt aktualisiert (Vorhandensein eines Backups wird empfohlen).
Grenzen
- Die mermaid.ink-API kann je nach Komplexität des Diagramms eine leichte Verzögerung aufweisen.
- Alle generierten Bilder werden vor Ort gespeichert; es erfolgt kein externes Hosting.
- Wenn die API nicht erreichbar ist (z. B. bei Netzwerkproblemen), wird der Vorgang abgebrochen.
Lizenz
MIT