mermaid cli Download - mermaid cli Source Code Download

mermaid cli

Autre code source

11.4.0

Télécharger

sirène-Cli

Il s'agit d'une interface de ligne de commande (CLI) pour la sirène. Il prend un fichier de définition de sirène en entrée et génère un fichier SVG / PNG / PDF en tant que sortie.

Installation

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

Usage

Convertir le fichier de diagramme MMD sirène en SVG

mmdc -i input.mmd -o output.svg

Note
Voir d'autres installations si vous ne souhaitez pas installer le package à l'échelle mondiale.
Localisez comment appeler l'exécutable MMDC pour votre méthode préférée, c'est-à-dire Docker, Yarn, NPM, Installer local, etc.

Exemples

Créez une PNG avec un thème sombre et un arrière-plan transparent

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

Animation d'un fichier SVG avec CSS personnalisé

L'option --cssFile peut être utilisée pour alimenter certains CSS personnalisés.

Veuillez voir ./Test-Positive/flowchart1.css pour un exemple de fichier CSS qui a des animations.

AVERTISSEMENT : Si vous souhaitez remplacer themeCSS de mermaid , nous vous recommandons d'ajouter à la place {"themeCSS": "..."}) à votre sirène --configFile . Vous devrez peut-être également l'utiliser !important pour remplacer themeCSS de Mermiade.

AVERTISSEMENT : Les fichiers CSS en ligne peuvent être bloqués par votre navigateur, selon l'en-tête HTTP Content-Security-Policy du site Web qui héberge votre SVG.

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

Exemple de sortie: docs / animé-flowchart.svg

Transformez un fichier Markdown avec des diagrammes de sirène

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

Cette commande transforme lui-même un fichier Markdown. La sirène-CLI trouvera les diagrammes de sirène, créera des fichiers SVG à partir d'eux et se référera à ceux de la sortie de Markdown.

Ce:

 ### 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
```

Devient:

 ### 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 ")

Piping de Stdin

Vous pouvez facilement tuer l'entrée de STDIN. Cet exemple montre comment utiliser un heredoc pour envoyer un diagramme en tant que stdin à Mermaid-CLI (MMDC).

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

Voir toutes les options disponibles

mmdc -h

Installations alternatives

Utilisez Docker / Podman:

docker pull minlag/mermaid-cli

ou tirez du registre des conteneurs GitHub

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

ou par exemple la version 8.8.0

docker pull minlag/mermaid-cli:8.8.0

Le conteneur recherche des fichiers d'entrée dans /data . Ainsi, par exemple, si vous avez un diagramme défini sur votre système dans /path/to/diagrams/diagram.mmd , vous pouvez utiliser le conteneur pour générer un fichier SVG comme suit:

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

Ou, si vous utilisez Podman, faites plutôt:

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

Les principales différences dans la commande podman par rapport à la commande docker sont:

L'ajout de l'argument --userns keep-id . Cela permet au conteneur de conserver le même UID que l'UID de l'utilisateur actuel dans l'espace de noms du conteneur au lieu de mappage vers un sous-UID. Les documents peuvent être trouvés ici
L'ajout de :z à la fin de la cartographie du volume. Cela demande à Podman de relancer les fichiers du volume avec le sellinux étiquette container_file_t , ce qui permet aux processus du conteneur d'accéder aux fichiers. Consultez la section "Étiquetage des supports de volume" ici pour plus d'informations.

Dans la version précédente, les fichiers d'entrée ont été montés dans /home/mermaidcli . Vous pouvez restaurer ce comportement avec l'option --workdir :

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

Utilisez l'API Node.js

Il est possible d'appeler mermaid-cli via une API Node.js. Veuillez noter que l'API NodeJS n'est pas couverte par Semver , car mermaid-cli suit le versioning de mermaid .

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

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

Installer localement

Certaines personnes ont des problèmes d'installation de cet outil à l'échelle mondiale. L'installer localement est une solution alternative:

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

Ou utilisez NPM:

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

Exécutez avec NPX

npx est installé par défaut avec NPM. Il télécharge et exécute les commandes en même temps. Pour utiliser Sirmaid CLI avec NPX, vous devez utiliser l'indicateur -p car le nom du package est différent de la commande qu'il installe ( mmdc ). npx -p @mermaid-js/mermaid-cli mmdc -h

Installer avec Brew

Avertissement
Cette méthode d'installation n'est plus prise en charge. Pour plus de détails, consultez la discussion. Une ancienne version de Mermaid-Cli peut être installée avec Brew.
brew install mermaid-cli