mermaid cli Download - mermaid cli Source Code Download

mermaid cli

شفرة المصدر الأخرى

11.4.0

تنزيل

حورية البحر cli

هذه واجهة سطر الأوامر (CLI) لحوريات البحر. يستغرق ملف تعريف حورية البحر كمدخل ويولد ملف SVG/PNG/PDF كإخراج.

تثبيت

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

الاستخدام

تحويل ملف رسم تخطيطي Mermaid MMD إلى SVG

mmdc -i input.mmd -o output.svg

ملحوظة
انظر عمليات تثبيت بديلة إذا كنت لا ترغب في تثبيت الحزمة على مستوى العالم.
حدد موقع كيفية استدعاء MMDC قابل للتنفيذ للطريقة المفضلة لديك IE Docker ، الغزل ، NPM ، التثبيت المحلي ، إلخ.

أمثلة

قم بإنشاء PNG بموضوع مظلم وخلفية شفافة

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

تحريك ملف SVG مع CSS مخصصة

يمكن استخدام خيار --cssFile لتضمين بعض CSS المخصصة.

يرجى الاطلاع على.

تحذير : إذا كنت ترغب في تجاوز themeCSS من mermaid ، فإننا نوصي بدلاً من ذلك بإضافة {"themeCSS": "..."}) إلى حورية البحر --configFile . قد تحتاج أيضًا إلى استخدامها !important تجاوز The Mermiad's themeCSS .

تحذير : قد يتم حظر ملفات CSS المضمنة من قبل متصفحك ، اعتمادًا على رأس محتوى HTTP-security-security-solice للموقع الذي يستضيف SVG.

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

مثال على الإخراج: مستندات/مرشح للرسوم المتحركة

قم بتحويل ملف Markdown بمخططات حورية البحر

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

يحول هذا الأمر ملف Markdown نفسه. ستجد Mermaid-Cli مخططات حورية البحر ، وإنشاء ملفات SVG منها وتشير إلى تلك الموجودة في إخراج Markdown.

هذا:

 ### 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 لإرسال مخطط كخطو إلى 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 للمستخدم الحالي في مساحة اسم الحاوية بدلاً من التعيين إلى Subuid. يمكن العثور على المستندات هنا
إضافة :z حتى نهاية رسم الخرائط. هذا يرشد PODMAN لإعادة توصيل الملفات في مستوى الصوت باستخدام Selinux Label container_file_t ، والذي يسمح للعمليات في الحاوية بالوصول إلى الملفات. راجع قسم "تصنيفات حجم العلامات" هنا لمزيد من المعلومات.

في الإصدار السابق ، تم تركيب ملفات الإدخال في /home/mermaidcli . يمكنك استعادة هذا السلوك باستخدام خيار --workdir :

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

استخدم Node.js API

من الممكن استدعاء mermaid-cli عبر API Node.js. يرجى العلم أن Semver NODEJS لا تتم تغطيتها ، حيث يتبع 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. يقوم بتنزيل الأوامر وتشغيلها في نفس الوقت. لاستخدام Mermaid CLI مع NPX ، تحتاج إلى استخدام علامة -p لأن اسم الحزمة يختلف عن الأمر الذي يتم تثبيته ( mmdc ). npx -p @mermaid-js/mermaid-cli mmdc -h