mermaid cli

putri duyung-cli

Ini adalah antarmuka baris perintah (CLI) untuk putri duyung. Dibutuhkan file definisi putri duyung sebagai input dan menghasilkan file svg/png/pdf sebagai output.

Instalasi

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

Penggunaan

Konversi File Diagram MMD Putri Duyung ke SVG

mmdc -i input.mmd -o output.svg

Catatan

Lihat instalasi alternatif jika Anda tidak ingin menginstal paket secara global.

Temukan cara menghubungi MMDC yang dapat dieksekusi untuk metode pilihan Anda yaitu Docker, benang, NPM, instalasi lokal, dll.

Contoh

Buat PNG dengan tema gelap dan latar belakang transparan

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

Menjiwai file SVG dengan CSS khusus

Opsi --cssFile dapat digunakan untuk melapisi beberapa CSS khusus.

Silakan lihat ./test-positive/flowchart1.css untuk contoh file CSS yang memiliki animasi.

PERINGATAN : Jika Anda ingin mengesampingkan themeCSS mermaid , kami sarankan untuk menambahkan {"themeCSS": "..."}) ke putri duyung Anda --configFile . Anda mungkin juga perlu menggunakan !important untuk mengesampingkan themeCSS DIGIAD.

PERINGATAN : File inline CSS dapat diblokir oleh browser Anda, tergantung pada header kebijakan konten-keamanan HTTP dari situs web yang meng-host SVG Anda.

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

Contoh Output: Docs/Animated-flowchart.svg

Mengubah file penurunan harga dengan diagram putri duyung

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

Perintah ini mengubah file penurunan harga itu sendiri. Dunia Duyung akan menemukan diagram putri duyung, membuat file SVG dari mereka dan merujuk pada yang ada di output markdown.

Ini:

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

Menjadi:

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

Perpipaan dari Stdin

Anda dapat dengan mudah menyalurkan input dari Stdin. Contoh ini menunjukkan cara menggunakan heredoc untuk mengirim diagram sebagai Stdin ke Mermaid-Cli (MMDC).

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

Lihat semua opsi yang tersedia

mmdc -h

Instalasi alternatif

Gunakan Docker/Podman:

docker pull minlag/mermaid-cli

atau tarik dari registri container github

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

atau misalnya versi 8.8.0

docker pull minlag/mermaid-cli:8.8.0

Wadah mencari file input di /data . Jadi misalnya, jika Anda memiliki diagram yang ditentukan pada sistem Anda di /path/to/diagrams/diagram.mmd , Anda dapat menggunakan wadah untuk menghasilkan file SVG sebagai berikut:

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

Atau, jika menggunakan podman, sebaliknya lakukan:

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

Perbedaan utama dalam perintah Podman versus perintah Docker adalah:

• Penambahan --userns keep-id . Ini memungkinkan wadah untuk menjaga UID yang sama dengan UID pengguna saat ini di wadah namespace alih -alih memetakan ke subuid. Dokumen dapat ditemukan di sini
• Penambahan :z ke akhir pemetaan volume. Ini menginstruksikan Podman untuk memberi ulang file dalam volume dengan label selinux container_file_t , yang memungkinkan proses dalam wadah untuk mengakses file. Lihat bagian "Labeling Volume Mounts" di sini untuk info lebih lanjut.

Dalam versi sebelumnya, file input dipasang di /home/mermaidcli . Anda dapat mengembalikan perilaku ini dengan opsi --workdir :

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

Gunakan Node.js API

Dimungkinkan untuk menghubungi mermaid-cli melalui API Node.js. Perlu diketahui bahwa API NodeJS tidak dicakup oleh SEMVER , karena mermaid-cli mengikuti versi mermaid .

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

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

Instal secara lokal

Beberapa orang mengalami masalah menginstal alat ini secara global. Memasangnya secara lokal adalah solusi alternatif:

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

Atau gunakan NPM:

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

Jalankan dengan NPX

npx diinstal secara default dengan NPM. Itu mengunduh dan menjalankan perintah secara bersamaan. Untuk menggunakan Mermaid Cli dengan NPX, Anda perlu menggunakan bendera -p karena nama paket berbeda dari perintah yang diinstalnya ( mmdc ). npx -p @mermaid-js/mermaid-cli mmdc -h

Instal dengan minuman

Peringatan

Metode pemasangan ini tidak lagi didukung. Untuk detail lebih lanjut, lihat diskusi. Versi lama Mermaid-Cli dapat diinstal dengan minuman.

brew install mermaid-cli

Masalah yang diketahui

1. Masalah Linux Sandbox
2. Izin Docker ditolak masalahnya
3. Bagaimana cara mengatur putri duyung untuk menggunakan kromium yang sudah dipasang?

Untuk kontributor

Kontribusi dipersilakan. Lihat Panduan Kontribusi.