mermaid cli Download - Herdownload mermaid cli -Quellcode

mermaid cli

Anderer Quellcode

11.4.0

Herunterladen

Meerjungfrau-Cli

Dies ist eine Befehlszeilenschnittstelle (CLI) für Meerjungfrau. Es dauert eine Mermaid -Definitionsdatei als Eingabe und generiert eine SVG/PNG/PDF -Datei als Ausgabe.

Installation

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

Verwendung

Konvertieren Sie die MMD -Diagrammdatei der Meerjungfrau in SVG

mmdc -i input.mmd -o output.svg

Notiz
Siehe alternative Installationen, wenn Sie das Paket nicht weltweit installieren möchten.
Suchen Sie, wie Sie die ausführbare MMDC -Datei für Ihre bevorzugte Methode aufrufen, dh Docker, Garn, NPM, lokale Installation usw.

Beispiele

Erstellen Sie ein PNG mit einem dunklen Thema und einem transparenten Hintergrund

mmdc -i input.mmd -o output.png -t dark -b transparent

Animieren einer SVG -Datei mit benutzerdefiniertem CSS

Die Option --cssFile kann verwendet werden, um einige benutzerdefinierte CSS zu inline.

Bitte beachten Sie ./test-Positiv/Flowchart1.css, ein Beispiel für eine CSS-Datei mit Animationen.

Warnung : Wenn Sie mermaid themeCSS überschreiben möchten, empfehlen wir stattdessen {"themeCSS": "..."}) Ihrer Meerjungfrau --configFile . Möglicherweise müssen Sie auch verwenden !important , um themeCSS von Mermiad zu überschreiben.

WARNUNG : Inline-CSS-Dateien können je nach HTTP-Content-Security-Policy-Header der Website, auf der Ihr SVG gehostet wird, von Ihrem Browser blockiert werden.

mmdc --input test-positive/flowchart1.mmd --cssFile test-positive/flowchart1.css -o docs/animated-flowchart.svg

Beispielausgabe: DOCS/Animated-Flowchart.svg

Verwandeln Sie eine Markdown -Datei mit Meerjungfrau -Diagrammen

mmdc -i readme.template.md -o readme.md

Dieser Befehl transformiert eine Markdown -Datei selbst. Der Meerjungfrau-CLI wird die Meerjungfrau-Diagramme finden, SVG-Dateien aus ihnen erstellen und auf die in der Markdown-Ausgabe beziehen.

Das:

 ### Some markdown
``` mermaid
graph
   [....]
```

### Some more markdown
``` mermaid
sequenceDiagram
   [....]
```

### Mermaid with custom title/desc
``` mermaid
graph
   accTitle: My title here
   accDescr: My description here
   A-->B
```

Wird:

 ### Some markdown
![ diagram ] ( ./readme-1.svg )

### Some more markdown
![ diagram ] ( ./readme-2.svg )

### Mermaid with custom title/desc
![ My description here ] ( ./readme-3.svg " My title here ")

Rohrleitungen aus Stdin

Sie können die Eingabe von Stdin problemlos übergeben. Dieses Beispiel zeigt, wie ein Heredoc verwendet wird, um ein Diagramm als stdin an mermaid-cli (MMDC) zu senden.

cat << EOF  | mmdc --input -
    graph TD
    A[Client] --> B[Load Balancer]
EOF

Sehen Sie alle verfügbaren Optionen an

mmdc -h

Alternative Installationen

Verwenden Sie Docker/Podman:

docker pull minlag/mermaid-cli

oder aus GitHub Container -Registrierung ziehen

docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli

oder zB Version 8.8.0

docker pull minlag/mermaid-cli:8.8.0

Der Container sucht nach Eingabedateien in /data . Wenn Sie beispielsweise ein Diagramm in Ihrem System in /path/to/diagrams/diagram.mmd definieren lassen, können Sie den Container wie folgt eine SVG -Datei generieren:

docker run --rm -u ` id -u ` : ` id -g ` -v /path/to/diagrams:/data minlag/mermaid-cli -i diagram.mmd

Oder wenn Sie Podman verwenden, tun Sie stattdessen:

podman run --userns keep-id --user ${UID} --rm -v /path/to/diagrams:/data:z ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -i diagram.mmd

Die wichtigsten Unterschiede im Befehl Podman im Vergleich zum Befehl Docker sind:

Die Hinzufügung des Arguments --userns keep-id . Auf diese Weise kann der Container dieselbe UID wie die UID des aktuellen Benutzers im Container -Namespace aufbewahren, anstatt auf eine Unteruid zuzuordnen. Dokumente können hier gefunden werden
Die Hinzufügung von :z bis zum Ende der Volumenzuordnung. Dadurch wird Podman angewiesen, die Dateien im Volumen mit dem Selinux -Label container_file_t neu zu relschließen, mit dem Prozesse im Container auf die Dateien zugreifen können. Weitere Informationen finden Sie im Abschnitt "Beschriftungsvolumen -Moderationen".

In der früheren Version wurden die Eingabedateien in /home/mermaidcli montiert. Sie können dieses Verhalten mit der Option --workdir wiederherstellen:

docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...]

Verwenden Sie node.js api

Es ist möglich, mermaid-cli über eine Node.js-API aufzurufen. Bitte beachten Sie, dass die NodeJS-API nicht von Semver abgedeckt ist , da mermaid-cli mermaid Versioning folgt.

 import { run } from "@mermaid-js/mermaid-cli"

await run (
   "input.mmd" , "output.svg" , // {optional options},
)

Lokal installieren

Einige Leute haben Probleme, dieses Tool weltweit zu installieren. Die lokale Installation ist eine alternative Lösung:

 npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h

Oder verwenden Sie NPM:

 npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h

Mit NPX laufen

npx ist standardmäßig mit NPM installiert. Es lädt gleichzeitig Befehle herunter und läuft. Um die Mermaid CLI mit NPX zu verwenden, müssen Sie das -p -Flag verwenden, da sich der Paketame von dem von ihm installierten Befehl unterscheidet ( mmdc ). npx -p @mermaid-js/mermaid-cli mmdc -h

Mit Brauen installieren

Warnung
Diese Installationsmethode wird nicht mehr unterstützt. Weitere Informationen finden Sie in der Diskussion. Eine alte Version von Mermaid-CLI kann mit Brew installiert werden.
brew install mermaid-cli