mermaid markdown diagrams flowchart documentation

Mermaid ใน Markdown: สร้างผังงาน ไดอะแกรมลำดับ และอื่น ๆ

เรียนรู้ไวยากรณ์ Mermaid สำหรับ Markdown ด้วยผังงาน ลำดับ คลาส แกนต์ แผนที่ความคิด และตัวอย่างไดอะแกรม ER พร้อมแสดงตัวอย่าง ส่งออก ความเข้ากันได้ และคำแนะนำในการเข้าถึง

W
WordToMD ทีม
·

ไดอะแกรมทางเทคนิคมักจะล้าสมัย เนื่องจากการแก้ไขจำเป็นต้องค้นหาไฟล์การออกแบบต้นฉบับ เปิดแอปพลิเคชันแยกต่างหาก และส่งออกรูปภาพอื่นMermaid ใช้แนวทางที่แตกต่างออกไป: แผนภาพถูกกำหนดให้เป็นข้อความและเก็บไว้ข้างเอกสารประกอบ

ในการเพิ่ม Mermaid ให้กับ Markdown ให้วางคำจำกัดความของไดอะแกรมไว้ภายในบล็อกโค้ดที่ไม่ชอบด้วยเครื่องหมาย mermaid ตัวระบุภาษาใช้ แสดงตัวอย่างแผนภาพ Mermaid เพื่อแสดงไวยากรณ์ในเครื่อง แก้ไขข้อผิดพลาด คัดลอกรั้ว Markdown ที่สมบูรณ์ หรือดาวน์โหลด SVG

คู่มือนี้เริ่มต้นด้วยผังงานขนาดเล็กและสร้างตามลำดับ คลาส แกนต์ แผนที่ความคิด และไดอะแกรมความสัมพันธ์เอนทิตี

Mermaid ใน 30 วินาที

บล็อก Mermaid พื้นฐานมีลักษณะดังนี้:

```mermaid
flowchart LR
  Draft --> Review
  Review --> Publish
```

รั้วเปิดจะบอกตัวเรนเดอร์ที่เข้ากันได้ว่าเนื้อหามีไวยากรณ์ Mermaid flowchart LR เลือกผังงานที่จัดเรียงจากซ้ายไปขวาบรรทัดที่เหลือกำหนดโหนดและการเชื่อมต่อ

หากปลายทางไม่รองรับ Mermaid ผู้อ่านมักจะเห็นบล็อกโค้ดแทนที่จะเป็นไดอะแกรมทางเลือกนั้นจะรักษาแหล่งที่มาไว้ แต่ไม่สามารถทดแทนการตรวจสอบความเข้ากันได้ก่อนที่จะเผยแพร่

เหตุใดจึงต้องใช้ไดอะแกรมแบบข้อความ

Mermaid มีประโยชน์อย่างยิ่งเมื่อมีไดอะแกรม:

  • เป็นของเอกสารควบคุมเวอร์ชัน
  • เปลี่ยนแปลงไปพร้อมกับรหัสหรือขั้นตอน;
  • ต้องการความแตกต่างคำขอดึงที่มีความหมาย
  • ใช้รูปร่างมาตรฐานและความสัมพันธ์
  • ควรสามารถแก้ไขได้โดยไม่ต้องมีไฟล์การออกแบบที่เป็นกรรมสิทธิ์
  • จะต้องสร้างขึ้นใหม่ในธีมสว่างและมืด

ไม่เหมาะสำหรับภาพประกอบที่มีรายละเอียด รูปแบบพิกเซลที่สมบูรณ์แบบ คำอธิบายประกอบด้วยมือเปล่า หรือการออกแบบภาพที่ต้องใช้การจัดวางด้วยตนเองอย่างแม่นยำในกรณีดังกล่าว ให้ใช้เครื่องมือวาดภาพและส่งออก SVG หรือรูปภาพที่สามารถเข้าถึงได้

ตัวอย่างที่ 1: ผังงาน

ผังงานอธิบายกระบวนการ การตัดสินใจ หรือกฎการกำหนดเส้นทาง

```mermaid
flowchart TD
  A[Choose a DOCX file] --> B{File valid?}
  B -->|Yes| C[Convert to Markdown]
  B -->|No| D[Show an error]
  C --> E[Review the output]
  E --> F[Copy or download]
```

ไวยากรณ์ที่สำคัญ:

  • TD หมายถึงจากบนลงล่าง
  • LR หมายถึงจากซ้ายไปขวา
  • [Text] สร้างโหนดกระบวนการสี่เหลี่ยม
  • {Text} สร้างโหนดการตัดสินใจ
  • --> สร้างการเชื่อมต่อแบบมีทิศทาง
  • -->|Label| เพิ่มข้อความในการเชื่อมต่อ

ใช้ ID โหนดสั้นที่เสถียร เช่น A or validate.เก็บป้ายกำกับที่มองเห็นไว้ในวงเล็บเพื่อให้การเปลี่ยนถ้อยคำไม่จำเป็นต้องเปลี่ยนทุกการเชื่อมต่อ

เพิ่มกราฟย่อย

ขั้นตอนที่เกี่ยวข้องกับกลุ่มกราฟย่อย:

```mermaid
flowchart LR
  subgraph Browser
    Upload[Choose file] --> Convert[Convert locally]
  end

  subgraph Output
    Preview[Preview Markdown] --> Save[Download file]
  end

  Convert --> Preview
```

ใช้กราฟย่อยเมื่อการจัดกลุ่มสื่อสารถึงความเป็นเจ้าของ ขอบเขตของระบบ หรือเฟสอย่าเพิ่มกล่องเพื่อการตกแต่งเท่านั้น

ตัวอย่างที่ 2: แผนภาพลำดับ

แผนภาพลำดับแสดงการโต้ตอบตามลำดับเวลาทำงานได้ดีสำหรับการเรียก API การตรวจสอบสิทธิ์ เวิร์กโฟลว์ของเบราว์เซอร์ และระบบที่ขับเคลื่อนด้วยเหตุการณ์

```mermaid
sequenceDiagram
  autonumber
  actor User
  participant Browser
  participant Converter

  User->>Browser: Select DOCX file
  Browser->>Converter: Pass local file data
  Converter-->>Browser: Return Markdown
  Browser-->>User: Show editable preview
```

ลูกศรทั่วไป:

  • ->> ส่งข้อความที่ชัดเจน
  • -->> ส่งการตอบกลับแบบประ
  • participant ประกาศระบบหรือบริการ
  • actor ประกาศบทบาทมนุษย์หรือภายนอก
  • autonumber ติดป้ายกำกับการโต้ตอบตามลำดับ

มุ่งเน้นไปที่สถานการณ์เดียวแผนภาพลำดับที่พยายามแสดงทุกทางเลือกและทุกฟังก์ชันภายในจะเข้าใจยากกว่าโค้ด

แสดงเส้นทางอื่น

```mermaid
sequenceDiagram
  participant Client
  participant API

  Client->>API: POST /documents
  alt Valid request
    API-->>Client: 201 Created
  else Invalid request
    API-->>Client: 400 Bad Request
  end
```

การใช้ alt, elseและ end สำหรับสาขาที่มีความหมายหากสาขาต้องการคำอธิบายหลายหน้า ให้ลิงก์ไปยังร้อยแก้วด้านล่างแผนภาพ

ตัวอย่างที่ 3: แผนผังชั้นเรียน

ไดอะแกรมคลาสอธิบายประเภท คุณสมบัติ การดำเนินการ การสืบทอด และความสัมพันธ์

```mermaid
classDiagram
  class Document {
    +String name
    +String content
    +convert()
  }

  class MarkdownDocument {
    +String frontmatter
    +render()
  }

  Document <|-- MarkdownDocument
```

ตัวอย่างนี้ระบุว่า MarkdownDocument สืบทอดมาจาก Documentใช้คลาสไดอะแกรมสำหรับโมเดลเชิงแนวคิด ไม่ใช่เป็นการแทนที่โดยอัตโนมัติสำหรับเอกสารอ้างอิง API ที่สมบูรณ์

ไดอะแกรมระดับดีละเว้นรายละเอียดที่ไม่ช่วยให้ผู้อ่านเข้าใจการออกแบบการแสดงทุกฟิลด์ส่วนตัวสามารถเปลี่ยนไดอะแกรมให้เป็นซอร์สโค้ดเวอร์ชันที่ค้นหาได้น้อยกว่า

ตัวอย่างที่ 4: แผนภูมิแกนต์

แผนภูมิแกนต์แสดงงานข้ามเวลามีประโยชน์สำหรับแผนการเผยแพร่ การย้าย และโครงการเอกสาร

```mermaid
gantt
  title Documentation migration
  dateFormat YYYY-MM-DD

  section Preparation
  Inventory content :done, inventory, 2026-11-03, 3d
  Define templates  :done, templates, after inventory, 2d

  section Migration
  Convert documents :active, convert, 2026-11-08, 7d
  Editorial review  :review, after convert, 5d

  section Publish
  Final validation  :validate, after review, 2d
```

เก็บวันที่ให้ชัดเจนและใช้รหัสงานเมื่องานหนึ่งขึ้นอยู่กับอีกงานหนึ่งโปรดจำไว้ว่าไดอะแกรมที่จัดเก็บไว้ในเอกสารประกอบจะไม่อัปเดตตัวเองเมื่อกำหนดการโครงการจริงเปลี่ยนแปลงมอบหมายความเป็นเจ้าของเพื่อให้เป็นปัจจุบัน

ตัวอย่างที่ 5: แผนที่ความคิด

แผนที่ความคิดจัดระเบียบความคิดตามหัวข้อหลัก

```mermaid
mindmap
  root((Markdown quality))
    Structure
      Headings
      Lists
      Tables
    Accessibility
      Alt text
      Link text
      Reading order
    Publishing
      GitHub
      Obsidian
      Documentation site
```

แผนที่ความคิดมีประสิทธิภาพมากที่สุดในระหว่างการวางแผนหรือเป็นภาพรวมระดับสูงสิ่งเหล่านี้มีประโยชน์น้อยกว่าสำหรับความสัมพันธ์ที่แม่นยำ เนื่องจากโครงสร้างแบบต้นไม้สามารถบอกเป็นนัยถึงลำดับชั้นที่แนวคิดที่แท้จริงทับซ้อนกัน

ตัวอย่างที่ 6: แผนภาพความสัมพันธ์เอนทิตี

แผนภาพ ER อธิบายเอนทิตีข้อมูลและความสัมพันธ์

```mermaid
erDiagram
  AUTHOR ||--o{ DOCUMENT : writes
  DOCUMENT ||--o{ REVISION : contains
  DOCUMENT }o--o{ TAG : uses

  AUTHOR {
    string id
    string name
  }

  DOCUMENT {
    string id
    string title
    datetime published_at
  }
```

ใช้ไดอะแกรม ER เพื่ออธิบายแบบจำลองและสคีมาหรือไฟล์การย้ายข้อมูลเพื่อกำหนดการใช้งานไดอะแกรมอาจละเว้นดัชนี ข้อจำกัด และฟิลด์ที่ไม่เกี่ยวข้องกับคำอธิบายปัจจุบัน

ดูตัวอย่าง Mermaid ก่อนเผยแพร่

การเขียนไดอะแกรมโดยตรงในเอกสาร Markdown ขนาดยาว ทำให้แยกข้อผิดพลาดทางไวยากรณ์ได้ยากการวนซ้ำการแสดงตัวอย่างแบบโฟกัสจะเร็วขึ้น:

  1. เปิด แสดงตัวอย่างแผนภาพ Mermaid.
  2. วางเฉพาะคำจำกัดความของไดอะแกรม โดยไม่มีรั้วโค้ดภายนอก
  3. แสดงผลไดอะแกรม
  4. อ่านข้อผิดพลาดทางไวยากรณ์และแก้ไขพื้นที่ที่อ้างอิง
  5. คัดลอก Markdown ที่มีรั้วกั้นที่สร้างขึ้น
  6. ดาวน์โหลด SVG เมื่อปลายทางต้องการสินทรัพย์คงที่
  7. ทดสอบ Markdown สุดท้ายในแพลตฟอร์มจริง

การแสดงตัวอย่างจะแสดงในเบราว์เซอร์ของคุณด้วยการกำหนดค่าความปลอดภัยที่เข้มงวดการเรียกกลับไดอะแกรมและลักษณะการทำงานแบบโต้ตอบอื่นๆ อาจถูกปิดใช้งาน แม้ว่าการติดตั้ง Mermaid อื่นจะอนุญาตก็ตามพฤติกรรมแบบอนุรักษ์นิยมนั้นเหมาะสมสำหรับเครื่องมือแสดงตัวอย่างทั่วไป

ข้อผิดพลาด Mermaid ทั่วไป

ไม่มีประเภทไดอะแกรม

ไม่ถูกต้อง:

A --> B

ถูกต้อง:

flowchart LR
  A --> B

บรรทัดแรกระบุไวยากรณ์ไดอะแกรม

เครื่องหมายวรรคตอนในป้ายกำกับแบ่งการแยกวิเคราะห์

อ้างป้ายกำกับที่ซับซ้อน:

flowchart LR
  A["Parse input: DOCX, HTML, or text"] --> B["Create Markdown"]

สิ่งนี้มีประโยชน์อย่างยิ่งสำหรับวงเล็บ เครื่องหมายวรรคตอน และป้ายกำกับที่มีลักษณะคล้ายไวยากรณ์

Word ที่สงวนไว้ถูกใช้โดยไม่คาดคิด

Mermaid ไวยากรณ์มีคำหลักเอกสารผังงานอย่างเป็นทางการเตือนว่าตัวพิมพ์เล็กโดยเฉพาะ end สามารถทำลายผังงานได้ทำให้เป็นตัวพิมพ์ใหญ่หรือวางข้อความที่มองเห็นได้ภายในป้ายโหนดที่ยกมา:

flowchart LR
  Start --> Finish["End"]

รั้วรหัสไม่ถูกต้อง

ตัวระบุภาษาอยู่ทันทีหลัง backticks ที่เปิด:

```mermaid
flowchart LR
  A --> B
```

อย่าเยื้องรั้วทั้งหมด เว้นแต่ว่าไวยากรณ์ Markdown โดยรอบจำเป็นต้องใช้

ใช้งานได้ในแพลตฟอร์มเดียวแต่ใช้ไม่ได้กับอีกแพลตฟอร์มหนึ่ง

Mermaid พัฒนาขึ้น และแพลตฟอร์มสามารถใช้ตัวเรนเดอร์ เวอร์ชัน การตั้งค่าความปลอดภัย และประเภทไดอะแกรมที่เปิดใช้งานที่แตกต่างกันคุณลักษณะไวยากรณ์ที่รองรับโดย Mermaid รุ่นใหม่ล่าสุดอาจล้มเหลวในแพลตฟอร์มที่ใช้การใช้งานอื่นหรือเวอร์ชันเก่ากว่า

ต้องการไวยากรณ์ที่ได้รับการสนับสนุนอย่างกว้างขวางสำหรับเอกสารที่ย้ายไปมาระหว่างแพลตฟอร์มทดสอบรูปร่าง ธีม คำสั่ง และประเภทไดอะแกรมขั้นสูงในทุกปลายทางที่ต้องการ

ความเข้ากันได้ของแพลตฟอร์ม

ความเข้ากันได้ควรได้รับการทดสอบแทนที่จะสันนิษฐาน:

แพลตฟอร์มวิธีการที่ได้รับการบันทึกไว้ในปัจจุบันหมายเหตุสำคัญ
GitHubใช้แบบมีรั้วกั้น mermaid blockGitHub เอกสารที่แสดงผลในไฟล์ Markdown ปัญหา การสนทนา คำขอดึง และวิกิ
GitLabใช้บล็อกโค้ด Mermaid ใน GitLab Flavoured MarkdownGitLab บันทึกเวอร์ชัน Mermaid ที่รองรับการติดตั้งแบบจัดการด้วยตนเองอาจแตกต่างกัน
Obsidianใช้แบบมีรั้วกั้น mermaid บล็อกในบันทึกย่อObsidian และฟีเจอร์ที่รองรับสามารถเปลี่ยนแปลงได้ระหว่างรุ่นต่างๆ
วัสดุสำหรับ MkDocsกำหนดค่ารั้วแบบกำหนดเอง Mermaidการรวมธีมดั้งเดิมต้องมีเอกสารประกอบ pymdownx.superfences configuration
ตัวแยกวิเคราะห์ Markdown ทั่วไปมักแสดงเฉพาะโค้ดเท่านั้นMermaid ต้องมีการรวม JavaScript หรือสร้างปลั๊กอิน

ตรวจสอบเอกสารอย่างเป็นทางการในปัจจุบันก่อนที่จะใช้คุณสมบัติที่ใหม่กว่า:

สำหรับไซต์เอกสารประกอบที่คุณควบคุม ให้ปักหมุดเวอร์ชันอ้างอิง Mermaid และทดสอบการอัพเกรดมิฉะนั้น การเปลี่ยนแปลงไวยากรณ์เล็กน้อยสามารถเปลี่ยนแปลงไดอะแกรมทั่วทั้งไซต์ได้

Mermaid และการเข้าถึง

SVG ที่แสดงผลไม่ได้สื่อสารความหมายของมันให้ผู้อ่านทุกคนทราบโดยอัตโนมัติถือว่าแผนภาพเป็นการสรุปด้วยภาพและให้คำอธิบายที่เทียบเท่ากันในร้อยแก้วใกล้เคียง

สำหรับผังงานการแปลงก่อนหน้านี้ ให้เพิ่มข้อความ เช่น:

ผู้ใช้เลือกไฟล์ DOCXไฟล์ที่ถูกต้องจะถูกแปลงในเครื่องและแสดงเพื่อตรวจสอบไฟล์ที่ไม่ถูกต้องทำให้เกิดข้อผิดพลาดจากนั้นผู้ใช้สามารถคัดลอกหรือดาวน์โหลด Markdown ที่ตรวจสอบแล้วได้

แนวทางปฏิบัติในการเข้าถึง:

  • แนะนำสิ่งที่แผนภาพอธิบาย
  • สรุปข้อสรุปหลังจากไดอะแกรมที่ซับซ้อน
  • ไม่เข้ารหัสความหมายด้วยสีเพียงอย่างเดียว
  • ใช้ป้ายกำกับที่อ่านได้แทนคำย่อภายใน
  • รักษาความแตกต่างที่เพียงพอในธีมสว่างและมืด
  • หลีกเลี่ยงไดอะแกรมที่ต้องใช้การโต้ตอบของเมาส์ที่แม่นยำ
  • จัดเตรียมข้อความหรือตารางทางเลือกสำหรับข้อมูลที่จำเป็น
  • ส่งออก SVG ด้วยความระมัดระวังเมื่อไฟล์คงที่ต้องมีชื่อที่สามารถเข้าถึงได้

ซอร์สโค้ดมีประโยชน์สำหรับผู้เขียน แต่ไม่จำเป็นต้องเป็นทางเลือกข้อความที่ดีสำหรับผู้อ่าน

การออกแบบไดอะแกรมที่สามารถอ่านได้

เก็บหนึ่งจุดประสงค์ต่อไดอะแกรม

แผนภาพควรตอบคำถามเช่น "จะเกิดอะไรขึ้นหลังจากคำขอที่ล้มเหลว"หรือ “บริการใดเป็นเจ้าของที่เก็บข้อมูลแต่ละแห่ง”หากพยายามอธิบายทั้งระบบ ให้แยกออก

ชอบป้ายกำกับแบบสั้น

ใส่คำอธิบายโดยละเอียดเป็นร้อยแก้วป้ายกำกับที่ยาวบังคับให้โหนดแคบ การตัดบรรทัดที่ดูอึดอัด และไดอะแกรมขนาดใหญ่บนหน้าจอมือถือ

ใช้ทิศทางอย่างตั้งใจ

การไหลจากซ้ายไปขวาทำงานได้ดีสำหรับกระบวนการสั้นๆ และเส้นทางคำขอการไหลจากบนลงล่างมักจะเหมาะกับหน้าจอแคบมากกว่าดูตัวอย่างทั้งสองก่อนดำเนินการ

จำกัดสไตล์การมองเห็น

สีที่กำหนดเองอาจขัดแย้งกับโหมดมืดหรือธีมแพลตฟอร์มเริ่มต้นด้วยค่าเริ่มต้นของตัวเรนเดอร์เพิ่มสไตล์เฉพาะเมื่อสื่อความหมายและยังคงอ่านได้ในธีมที่จำเป็นทั้งหมด

เก็บแหล่งที่มาไว้ใกล้คำอธิบาย

เก็บบล็อก Mermaid ไว้ในไฟล์ Markdown เดียวกันเมื่อเป็นไปได้นั่นทำให้ร้อยแก้วและแผนภาพเปลี่ยนไปพร้อมกันในการทบทวนครั้งเดียว

Mermaid เทียบกับภาพนิ่ง

เลือก Mermaid เมื่อ:

  • แผนภาพมีการเปลี่ยนแปลงบ่อยครั้ง
  • ความแตกต่างของแหล่งที่มามีคุณค่า
  • เค้าโครงใช้ประเภทไดอะแกรมมาตรฐาน
  • แพลตฟอร์มการเผยแพร่ทำให้ Mermaid เชื่อถือได้

เลือก SVG หรือ PNG เมื่อ:

  • การออกแบบต้องมีรูปแบบคู่มือที่แม่นยำ
  • ปลายทางไม่แสดงผล Mermaid;
  • ลักษณะที่ปรากฏที่แน่นอนจะต้องคงอยู่
  • การแชร์ภายนอกต้องใช้เนื้อหาแบบสแตนด์อโลน

แบบผสมที่มีประโยชน์คือการรักษาแหล่งที่มา Mermaid และส่งออก SVG สำหรับปลายทางที่ไม่สามารถแสดงผลได้เก็บแหล่งที่มาไว้ข้างเนื้อหาที่ส่งออกและบันทึกวิธีการสร้างใหม่

การใช้ Markdown เป็นรูปภาพ สำหรับเนื้อหา Markdown ที่แชร์ได้ หรือดาวน์โหลด SVG โดยตรงจาก แสดงตัวอย่างแผนภาพ Mermaid เมื่อไดอะแกรมเป็นสินทรัพย์

FAQ

Mermaid เป็นส่วนหนึ่งของมาตรฐาน Markdown หรือไม่

ไม่รั้ว mermaid เป็นส่วนขยายที่แอปพลิเคชันและระบบการสร้างที่เข้ากันได้ยอมรับโปรแกรมแยกวิเคราะห์ Markdown พื้นฐานอาจแสดงผลเป็นโค้ดธรรมดา

GitHub เรนเดอร์ไดอะแกรม Mermaid หรือไม่

ใช่เอกสารประกอบของ GitHub อธิบายการเรนเดอร์ Mermaid ในไฟล์ Markdown และแพลตฟอร์มการทำงานร่วมกันต่างๆทดสอบไวยากรณ์ที่ใหม่กว่าเนื่องจาก GitHub ควบคุมการตั้งค่าตัวแสดงผลและความปลอดภัยที่ปรับใช้

ฉันสามารถใช้ Mermaid ใน Obsidian ได้หรือไม่

Obsidian บล็อกไดอะแกรมรั้วสไตล์ Mermaid ในบันทึกย่อการสนับสนุนคุณสมบัติสามารถเปลี่ยนแปลงได้ด้วยตัวเรนเดอร์ของแอปพลิเคชัน ดังนั้นโปรดตรวจสอบประเภทไดอะแกรมที่ซับซ้อนหรือที่เพิ่งเปิดตัวในเวอร์ชันที่ติดตั้งของคุณ

Mermaid สามารถแทนที่เอกสารสถาปัตยกรรมได้หรือไม่

ไม่ ไดอะแกรมคือมุมมองเดียวของระบบจับคู่กับการตัดสินใจ ความเป็นเจ้าของ ข้อจำกัด พฤติกรรมความล้มเหลว และลิงก์ไปยังอินเทอร์เฟซหรือสคีมาที่เชื่อถือได้

เหตุใดไดอะแกรมของฉันจึงแสดงผลแตกต่างออกไปในโหมดมืด

แพลตฟอร์มอาจใช้ธีม Mermaid ตัวแปร CSS แบบอักษร และพื้นหลังที่แตกต่างกันหลีกเลี่ยงสีที่ฮาร์ดโค้ดจนกว่าคุณจะทดสอบทั้งสองธีมแล้ว

ฉันควรส่งไฟล์ SVG ที่ส่งออกหรือไม่

ยอมรับ SVG เมื่อปลายทางการเผยแพร่ต้องการสินทรัพย์คงที่ หรือผลลัพธ์ที่แสดงผลจะต้องคงที่เก็บแหล่งที่มา Mermaid และกระบวนการสร้างใหม่ที่ได้รับการบันทึกไว้เพื่อป้องกันไม่ให้ทั้งสองเวอร์ชันลอยไป

Mermaid ปลอดภัยสำหรับไดอะแกรมที่เป็นความลับหรือไม่

การรักษาความลับขึ้นอยู่กับบรรณาธิการและเวิร์กโฟลว์การเผยแพร่การแสดงตัวอย่างของ WordToMD จะแสดงไดอะแกรมในเบราว์เซอร์ของคุณ แต่การเผยแพร่ Markdown หรือ SVG ไปยังที่เก็บหรือไซต์จะเป็นไปตามการควบคุมการเข้าถึงของปลายทางนั้น

การสรุป

Mermaid ทำให้ไดอะแกรมสามารถบำรุงรักษาได้เนื่องจากแหล่งที่มาอยู่กับ Markdownเริ่มต้นด้วยบล็อกรั้วเล็กๆ เลือกประเภทไดอะแกรมที่ตรงกับคำถาม ดูตัวอย่างไวยากรณ์ และทดสอบในตัวเรนเดอร์ขั้นสุดท้ายใช้ร้อยแก้วเพื่ออธิบายความหมายที่สำคัญและส่งออก SVG เมื่อปลายทางต้องการสินทรัพย์คงที่

ลองตัวอย่างใน แสดงตัวอย่างแผนภาพ Mermaidแก้ไขเอกสารโดยรอบใน Markdown บรรณาธิการและให้ความสำคัญกับไดอะแกรมเพียงพอที่ผู้ร่วมให้ข้อมูลในอนาคตสามารถเข้าใจและอัปเดตได้โดยไม่ต้องวาดทั้งหน้าใหม่