The Official Guide to Mermaid.js: Create complex diagrams and beautiful flowcharts easily using text and code
暫譯: Mermaid.js 官方指南：輕鬆使用文本和程式碼創建複雜圖表和美觀流程圖

#### 主要特點

- 學習如何使用和自訂 Mermaid 中的不同圖表類型
- 探索如何將 Mermaid 添加到文檔系統的範例
- 使用 Mermaid 與各種可用工具，如編輯器、維基等

#### 書籍描述

Mermaid 是一個基於 JavaScript 的圖表和圖示工具，讓您可以使用文本和代碼來表示圖示，這簡化了複雜圖示的維護。對於開發人員來說，這是一個很好的選擇，因為他們對代碼更為熟悉，而不是使用專門的工具來生成圖示。此外，代碼中的圖示簡化了維護，並確保代碼受到版本控制系統的支持。在某些情況下，Mermaid 使得重構支持名稱變更成為可能，同時也促進了團隊協作以進行審查分發和更新。

任何系統的開發人員都能夠利用這本實用指南將他們的知識應用於使用 Mermaid 進行文檔編寫。這本書也是查找特定圖示語法的絕佳參考，當您在創建圖示時可以使用。

您將首先學習準確和可視化文檔的重要性。接下來，書中介紹了 Mermaid 並建立了如何使用它來創建有效文檔的基礎。通過使用不同的工具、編輯器或自訂文檔平台，您還將了解如何使用 Mermaid 語法來繪製各種圖示。後面的章節涵蓋了高級配置設置和主題選項，以根據您的需求來操作圖示。

在本書結束時，您將熟悉 Mermaid 圖示及其在工作流程中的應用。

#### 您將學到的內容

- 理解良好和不良文檔，以及有效文檔的藝術
- 熟練掌握輕鬆維護複雜圖示的技巧
- 探索如何繪製不同類型的 Mermaid 圖示，如流程圖、類別圖、甘特圖等
- 在您的工作流程中實施 Mermaid 圖示
- 理解如何為 Mermaid 圖示或整個網站設置主題
- 熟悉設置自訂文檔系統的過程

#### 本書適合誰

本書適合內容生成者，如技術作家、開發人員、架構師、業務分析師和希望學習有效文檔或如何使用簡單的文本代碼片段有效表示圖示並提取它們的管理者。熟悉使用 Markdown 進行文檔編寫將會有所幫助，但不是必需的。

Knut Sveidqvist has been in the software industry for over 20 years in roles spanning all the way from architecture to development through product ownership and managing development teams. A common theme in all these roles is the need for good documentation. This inspired Knut to create Mermaid and start the Mermaid open source project. The main goal with the project was and still is to make it more fun and efficient to write technical documentation. Ever since Knut created Mermaid, he has continued to work with the project and has a wealth of knowledge about Mermaid that he now wants to share with the developer community.

Ashish Jain has more than 8 years of experience as a technical lead and developer with a bachelor's degree in information technology. He started as a Java backend developer then moved to full-stack development. Within these roles, he worked on project documentation and other documented deliverables, where the need to have a simpler way to draw and integrate diagrams in documents was felt. His search ended with Mermaid, which impressed him enough to see him associate himself with the Mermaid project. He is an open source contributor and a part of the Mermaid core team.

Knut Sveidqvist 在軟體產業已有超過 20 年的經驗，擔任過從架構設計到開發、產品負責人以及管理開發團隊等多種角色。這些角色中共同的主題是對良好文件的需求。這激發了 Knut 創建 Mermaid 並啟動 Mermaid 開源專案。該專案的主要目標是讓撰寫技術文件變得更有趣且更有效率。自從 Knut 創建 Mermaid 以來，他持續參與該專案，並擁有豐富的 Mermaid 知識，現在希望與開發者社群分享。

Ashish Jain 擁有超過 8 年的技術領導和開發經驗，並持有資訊科技的學士學位。他最初是 Java 後端開發人員，然後轉向全端開發。在這些角色中，他參與了專案文件和其他文檔交付物的工作，並感受到需要一種更簡單的方法來繪製和整合文檔中的圖表。他的搜尋最終以 Mermaid 為結束，這讓他印象深刻，並使他決定與 Mermaid 專案結合。他是一名開源貢獻者，也是 Mermaid 核心團隊的一員。

Table of Contents

1. The Art of Documentation with Mermaid
2. How to Use Mermaid
3. Mermaid Versions and Using the Live Editor
4. Modifying Configurations with or without Directives
5. Changing Themes and Making Mermaid Look Good
6. Using Flowcharts
7. Creating Sequence Diagrams
8. Rendering Class Diagrams
9. Illustrating Data with Pie Charts and Understanding Requirement Diagrams
10. Demonstrating Connections Using Entity Relationship Diagrams
11. Representing System Behavior with State Diagrams
12. Visualizing Your Project Schedule with Gantt Chart Diagrams
13. Presenting User Behavior with User Journey Diagrams

Table of Contents

1. The Art of Documentation with Mermaid


2. How to Use Mermaid


3. Mermaid Versions and Using the Live Editor


4. Modifying Configurations with or without Directives


5. Changing Themes and Making Mermaid Look Good


6. Using Flowcharts


7. Creating Sequence Diagrams


8. Rendering Class Diagrams


9. Illustrating Data with Pie Charts and Understanding Requirement Diagrams


10. Demonstrating Connections Using Entity Relationship Diagrams


11. Representing System Behavior with State Diagrams


12. Visualizing Your Project Schedule with Gantt Chart Diagrams


13. Presenting User Behavior with User Journey Diagrams