Mermaid 看板圖表文件
Mermaid 的看板圖表可讓您建立視覺化表示,呈現任務在工作流程中不同階段的移動。本指南說明如何使用看板圖表語法,基於提供的範例。
概觀
Mermaid 中的看板圖表以 `kanban` 關鍵字開始,後接欄(階段)和這些欄中的任務定義。
定義欄
欄代表您工作流程中的不同階段,例如「待辦事項」、「進行中」、「完成」等。每個欄都使用唯一的識別碼和括在方括號中的標題來定義。
語法
columnId[Column Title]
- `columnId`: 欄的唯一識別碼。
- `[欄標題]`: 顯示在欄標題上的標題。
例如 `id1[待辦事項]`
新增任務至欄
任務會在其各自的欄下列出,並帶有縮排。每個任務也都有唯一的識別碼和括在方括號中的描述。
語法
taskId[Task Description]
• taskId: A unique identifier for the task.
• [Task Description]: The description of the task.
範例
docs[Create Documentation]
新增中繼資料至任務
您可以使用 `@{ ... }` 語法為每個任務包含其他中繼資料。中繼資料可以包含鍵值對,例如 assigned、ticket、priority 等。這將被渲染並新增至節點的渲染中。
支援的中繼資料鍵
• assigned: Specifies who is responsible for the task.
• ticket: Links the task to a ticket or issue number.
• priority: Indicates the urgency of the task. Allowed values: 'Very High', 'High', 'Low' and 'Very Low'
配置選項
您可以使用 Markdown 檔案開頭的配置區塊來自訂看板圖表。這對於設定全域設定(例如票證的基本 URL)很有用。目前看板圖表有一個配置選項 `tacketBaseUrl`。可以按照以下範例設定
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
當看板項目有指定的票證號碼時,圖表中的票證號碼會連結到外部系統,其中定義了該票證。`ticketBaseUrl` 設定外部系統的基本 URL,`#TICKET#` 會被任務中繼資料中的票證值取代,以建立有效的連結。
完整範例
以下是基於所提供範例的完整看板圖表
總之,在 Mermaid 中建立看板圖表是一個直接的過程,可以有效地視覺化您的工作流程。首先使用 `kanban` 關鍵字來啟動圖表。定義您的欄,並使用唯一的識別碼和標題來代表您專案的不同階段。在每個欄下,列出您的任務(也具有唯一的識別碼),並根據需要提供詳細的描述。請記住,正確的縮排至關重要;任務必須在父欄下縮排,以維持正確的結構。
您可以使用 `@{ ... }` 語法將選用的中繼資料新增至任務,從而增強圖表,這樣您就可以包含其他內容,例如受讓人、票證號碼和優先順序層級。為了進一步自訂,請使用檔案頂端的配置區塊來設定全域選項,例如 `ticketBaseUrl`,以便直接從您的圖表連結票證。
透過遵循這些準則(確保唯一的識別碼、正確的縮排,並使用中繼資料和配置選項),您可以建立一個全面且自訂的看板,有效地利用 Mermaid 繪製出您專案的工作流程。