Скачать mermaid cli - Скачать исходный код mermaid cli

mermaid cli

Другой исходный код

11.4.0

Скачать

русалка-клин

Это интерфейс командной строки (CLI) для русалки. Он принимает файл определения русалки в качестве входного ввода и генерирует файл SVG/PNG/PDF в качестве вывода.

Установка

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

Использование

Конвертировать файл диаграммы MMD MMD в SVG

mmdc -i input.mmd -o output.svg

Примечание
Смотрите альтернативные установки, если вы не хотите устанавливать пакет по всему миру.
Найдите, как вызвать исполняемый файл MMDC для вашего предпочтительного метода, то есть Docker, пряжа, NPM, локальная установка и т. Д.

Примеры

Создайте PNG с темной темой и прозрачным фоном

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

Анимация файла SVG с помощью пользовательских CSS

Параметр --cssFile можно использовать для внедрения некоторых пользовательских CSS.

Пожалуйста, см.

ПРЕДУПРЕЖДЕНИЕ : Если вы хотите переопределить themeCSS 's mermaid 's, мы рекомендуем вместо этого добавить {"themeCSS": "..."}) к вашей русалке --configFile . Вам также может понадобиться использовать !important , чтобы переопределить themeCSS Mermiad.

Предупреждение : встроенные файлы CSS могут быть заблокированы вашим браузером, в зависимости от заголовка HTTP-политики-политики на веб-сайте, на котором размещается ваш SVG.

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

Пример вывода: Docs/Animated-Flowchart.svg

Преобразовать файл разметки с помощью диаграмм русалки

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

Эта команда преобразует сам файл разметки. Mermaid-Cli найдет диаграммы русалки, создаст из них файлы SVG и ссылается на выход на выходе на уценку.

Этот:

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

Становится:

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

Трубопровод от Stdin

Вы можете легко поднять вход из Stdin. В этом примере показано, как использовать Heredoc для отправки диаграммы в качестве stdin в Mermaid-Cli (MMDC).

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

Смотрите все доступные варианты

mmdc -h

Альтернативные установки

Используйте Docker/Podman:

docker pull minlag/mermaid-cli

или вытянуть из реестра контейнеров GitHub

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

или, например, версия 8.8.0

docker pull minlag/mermaid-cli:8.8.0

Контейнер ищет входные файлы в /data . Так, например, если у вас есть диаграмма, определенная в вашей системе в /path/to/diagrams/diagram.mmd , вы можете использовать контейнер для генерации файла SVG следующим образом:

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

Или, если использовать Podman, вместо этого сделайте:

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

Ключевые различия в команде Podman по сравнению с командой Docker:

Добавление аргумента- --userns keep-id . Это позволяет контейнеру сохранять тот же UID, что и UID текущего пользователя в пространстве имен контейнеров, а не сопоставление с подтекалом. Документы можно найти здесь
Добавление :z к концу картирования тома. Это инструктирует Podman для перераспределения файлов в томе с помощью метки Selinux container_file_t , который позволяет процессам в контейнере доступа к файлам. См. Раздел «Makeling Tolum Mounts» здесь для получения дополнительной информации.

В предыдущей версии входные файлы были установлены в /home/mermaidcli . Вы можете восстановить это поведение с помощью варианта --workdir :

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

Используйте node.js api

Можно вызвать mermaid-cli через API node.js. Имейте в виду, что API Nodejs не покрывается SEMVER , поскольку mermaid-cli следует за версией mermaid .

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

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

Установить локально

У некоторых людей проблемы с установкой этого инструмента во всем мире. Установка его локально является альтернативным решением:

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

Или используйте NPM:

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

Беги с NPX

npx устанавливается по умолчанию с NPM. Он загружает и запускает команды одновременно. Чтобы использовать CLI Mermaid с NPX, вам необходимо использовать флаг -p , потому что имя пакета отличается от команды, которую он устанавливает ( mmdc ). npx -p @mermaid-js/mermaid-cli mmdc -h

Установите с помощью Brew

Предупреждение
Этот метод установки больше не поддерживается. Для получения более подробной информации см. Обсуждение. Старая версия Mermaid-Cli может быть установлена с помощью варева.
brew install mermaid-cli