Panduan Praktis

Generator Bagan — Panduan Penggunaan dan Prinsip Teknis

Buat flowchart, diagram dengan sintaks Mermaid dan penyunting visual

Buka alat

Ringkasan

Mermaid adalah alat diagnosis yang menghasilkan diagram dari sintaks seperti markdown. Ini memungkinkan membuat diagram flowchart, diagram urutan, diagram kelas, diagram negara, dan lebih menggunakan deskripsi teks sederhana daripada dragdown dan menjatuhkan penyunting. Sintaks menggunakan kata kunci (grafik, sequenceDigram, gantt) diikuti dengan definisi dan koneksi (A-->B, peserta Alice). Mermaid merender diagram dalam format SVG, membuat mereka dapat diperskalaan dan digelapkan dalam dokumentasi, wiki, presentasi. Manfaat termasuk pengontrol versi (diagram sebagai kode), pemutakhiran mudah, gaya konsisten, dan tidak perlu perangkat lunak diagram khusus. Widelly digunakan dalam GitHub markdown, Notion, GitLab, Confluence, dan dokumentasi teknis.

Konsep utama

Basis Syntax Putri Duyung

Diagram Mermaid dimulai dengan tipe deklarasi: graph TD (flowchart top-down), graph LR (Left-right), sequenceDiagram, gantt, classDiagram, stateDiagram, erDiagram, pie. Nodes didefinisikan sebagai id [text] atau id (text) untuk bentuk yang berbeda: [] rectangle, () bulat, {} rhombus, () lingkaran, [] subbroutine:> (solid), -.-> (putus), = => (tebal), --text--> (berlabel). Subgraphs grup node: subgraph title... end. Styling via%% {init: {'theme': 'dark'}:% or inline style id::: ClasName. Komentar dimulai dengan%%. Karakter spesial lolos atau dikutip. Indentasi untuk rekabilitas.

Spesifik Tipe Diagram

Flowcharts: Gunakan grafik TB / TD / BT / RL / LR untuk arah. Mendukung titik keputusan (rhombus), proses (rectangle), start / end (bulat). Diagram Sequence: Definisikan partisipan, pesan (->>, -->>, -x), kotak aktivasi (aktifkan / menonaktifkan), catatan (Note kiri / kanan). Grafik Gantt: define tugas dengan tanggal awal, durasi, ketergantungan (setelah taksId). Diagram kelas: Tentukan kelas, atribut, metode, hubungan (warisan <|, komposisi * --, kumpulan o--). Diagram negara: Amerika, transisi, node pilih. setiap tipe memiliki aturan sintaks tertentu dan render logika.

Mesin Perincian

Pustaka Mermaid.js mem-parsing sintaksis teks menjadi Pohon Sintaks Abstrak (AST), lalu dirender ke SVG menggunakan D3.js untuk tata letak grafik. Algoritme tata letak: Dagre untuk diagram alur (tata letak berlapis hierarki), diarahkan secara paksa untuk bentuk organik. Generasi SVG menciptakan bentuk (z<rect>, <circle>, <path>), teks (<text>), konektor (<line>, <path> dengan spidol). Tema diterapkan melalui kelas CSS yang tertanam dalam SVG. Fitur interaktif: zoom/pan, tooltips, penangan klik. Render browser menggunakan <div class="mermaid">...code...</div> dengan Mermaid.initialize() atau generasi SVG mandiri. Render sisi server dimungkinkan dengan Puppeteer/mermaid-cli untuk keluaran statis.

Fitur Lanjutan

Mermaid mendukung diagnosis lanjutan: Subgrap membuat struktur nested. Bergaya dengan class Def dan kelas yang berlaku CSS. Links: klik nodeId "url" membuka URL. Callback: klik nodeId pemicu JavaScript fungsi. FontAwesome ikon dalam node: fa: fa-icon. Markdown memformat dalam label menggunakan quotes. Sequences support loops (loop... end), alphinstandard / end / end (lain / end) (paralel)...) Gantt mendukung bagian, tonggak, aktif / selesai / crit menyatakan. Diagram ER menampilkan kardinalitas (||--o {, satu-ke-banyak). Keamanan: bersihkan masukan pengguna untuk mencegah penangan klik XSS. Versi kompatibilitas: periksa versi minid.js untuk dukungan sintaks.

Fitur

Tipe Diagram Berganda

Dukung flowcharts (graph TB / LR), diagram urutan, grafik Gantt, diagram kelas, mesin negara, diagram ER, grafik, peta perjalanan pengguna dengan sintaks typet- spesifik dan render

Mode Editing Dual

Penyunting teks dengan sintaks Mermaid yang menyoroti, otomatis lengkap, dan deteksi kesalahan, atau penggambaran visual dan -drop penyunting (opsional) dengan kode bidirectional sync untuk pemutakhiran diagram instan

Tema Dapat Diatur

Pilih dari built-in tema (baku, hutan, gelap, netral) atau warna gubahan, fonta, bentuk, gaya garis, jarak node untuk tampilan diagram konsisten yang cocok dengan merek Anda

Ekspor Multi- Format

Ekspor diagram sebagai SVG (scalable vector), PNG (raster dengan resolusi yang dapat diubah), PDF (untuk mencetak / berbagi), atau salin kode Mermaid untuk menggelapkan dokumentasi markdown

Skenario Aplikasi

Dokumentasi Teknis

Buat diagram arsitektur sistem, flowchart API, dan proses dokumentasi dalam berkas README, wiki, dan dokumentasi teknis. Masukan kode Mermaid secara langsung dalam markdown untuk render otomatis di GitHub, GitLab, dan Notion.

Manajemen Projek

Gunakan grafik Gantt untuk merencanakan jadwal proyek, visualisasikan ketergantungan tugas, dan lacak milestone. Mutakhirkan rencana sebagai diagram berbasis teks yang dapat dikendalikan secara version- mudah dibagi dengan anggota tim.

Dokumentasi Proses Bisnis

Bisnis dokumen mengalir, proses persetujuan, dan peta perjalanan pengguna menggunakan flowchart. Berbagi diagram proses dengan pemegang saham dan dengan mudah memodifikasi mereka berdasarkan umpan balik tanpa perangkat lunak pengdiagnosa khusus.

Desain Perangkat Lunak

Desain arsitektur perangkat lunak dengan diagram kelas, model basis data skema dengan diagram ER, dan memvisualisasikan mesin negara dengan diagram negara. Iterate pada desain sebagai kode yang berkembang dengan proyek Anda.

Pertanyaan umum

Apa itu Putri Duyung dan mengapa menggunakan diagram berbasis teks?

Mermaid adalah alat diagram berbasis teks yang menghasilkan diagram dari sintaksis seperti penurunan harga. Menggunakan teks dibandingkan editor grafis memberikan manfaat utama: kontrol versi (diagram dapat dilacak dalam kode seperti Git), kolaborasi yang mudah (berbagi dan mengedit teks biasa), otomatisasi (menghasilkan diagram secara terprogram), konsistensi (tema memastikan gaya yang seragam), dan tidak memerlukan perangkat lunak khusus. Ini ideal untuk dokumentasi, penulisan teknis, dan alur kerja pengembangan.

Diagram macam apa yang bisa kubuat dengan Mermaid?

Mermaid mendukung beberapa jenis diagram: Diagram alur (alur proses, pohon keputusan), Diagram urutan (interaksi sistem, panggilan API), Bagan Gantt (jadwal waktu proyek), Diagram kelas (model objek UML), Diagram status (mesin status), Diagram ER (skema basis data), Diagram lingkaran (data proporsional), Peta perjalanan pengguna (alur pengguna), dan Grafik Git (riwayat cabang). Setiap tipe memiliki sintaks khusus untuk node, koneksi, dan properti.

Bagaimana cara mengekspor diagram untuk digunakan dalam dokumentasi atau presentasi?

Anda dapat mengekspor diagram dalam berbagai format: SVG (grafik vektor yang dapat diskalakan) untuk rendering yang tajam pada ukuran apa pun dan pengeditan dalam alat vektor, PNG (gambar raster) dengan resolusi yang dapat disesuaikan untuk disematkan dalam dokumen, PDF untuk dicetak dan dibagikan, atau salin kode Mermaid secara langsung untuk disematkan dalam file Markdown, GitHub README, halaman Notion, wiki GitLab, atau dokumentasi Confluence yang mendukung Mermaid secara asli.

Dapatkah saya menyesuaikan penampilan diagram saya?

Ya, Mermaid menawarkan penyesuaian ekstensif: Tema bawaan (default, hutan, gelap, netral) mengubah skema warna keseluruhan. Anda dapat menentukan kelas CSS khusus dengan classDef dan menerapkannya ke node. Penataan simpul individual mendukung bentuk, warna, batas, dan font khusus. Gaya koneksi dapat berupa panah padat, putus-putus, atau tebal dengan label opsional. Pengguna tingkat lanjut dapat memasukkan CSS khusus atau menggunakan variabel tema untuk mencocokkan warna merek dan sistem desain.

Apakah Mermaid didukung pada semua platform?

Mermaid secara asli didukung oleh banyak platform termasuk GitHub, GitLab, Notion, Confluence, VS Code, dan Obsidian. Untuk platform tanpa dukungan asli, Anda dapat mengekspor diagram sebagai SVG atau PNG dan menyematkannya sebagai gambar. Untuk aplikasi web, Anda dapat mengintegrasikan perpustakaan Mermaid.js untuk mengaktifkan rendering sisi klien.

Dokumen Terkait

Generator Bagan

Buka alat untuk mencoba fitur ini.

Buka alat