Mermaid中文文档

Appearance

Mermaid Kanban 图表文档 ​

Mermaid 的 Kanban 图表允许您创建工作流不同阶段任务的可视化表示。本指南基于提供的示例解释如何使用 Kanban 图表语法。

概述 ​

Mermaid 中的 Kanban 图表以 kanban 关键字开头，后跟列（阶段）和这些列中任务的定义。

Code:
mermaid

定义列 ​

列代表工作流中的不同阶段，例如“待办”、“进行中”、“已完成”等。每列都使用唯一的标识符和方括号中包含的标题来定义。

语法：

columnId[Column Title]
  • columnId：列的唯一标识符。
  • [Column Title]：列标题中显示的标题。

例如 id1[Todo]

向列中添加任务 ​

任务在其各自的列下以缩进方式列出。每个任务也都有一个唯一的标识符和方括号中包含的描述。

语法：

taskId[Task Description]
•	taskId：任务的唯一标识符。
•	[Task Description]：任务的描述。

示例：

docs[Create Documentation]

向任务添加元数据 ​

您可以使用 @{ ... } 语法为每个任务包含附加的元数据。元数据可以包含键值对，例如分配者、工单、优先级等。这将被添加到节点的渲染中。

支持的元数据键 ​

•	assigned：指定谁负责该任务。
•	ticket：将任务链接到工单或问题编号。
•	priority：指示任务的紧急程度。允许的值：'Very High'、'High'、'Low' 和 'Very Low'
Code:
mermaid

配置选项 ​

您可以使用 markdown 文件开头的配置块来自定义 Kanban 图表。这对于设置全局设置（如工单的基准 URL）非常有用。目前 Kanban 图表只有一个配置选项 ticketBaseUrl。可以按以下示例设置：

yaml
---
config:
  kanban:
    ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---

当 Kanban 项目具有分配的工单号时，图表中的工单号将链接到定义工单的外部系统。ticketBaseUrl 将基准 URL 设置为外部系统，并且 #TICKET# 将被替换为任务元数据中的工单值以创建有效的链接。

##完整示例

以下是基于提供的示例的完整 Kanban 图表：

Code:
mermaid

总之，在 Mermaid 中创建 Kanban 图表是一个简单的过程，可以有效地可视化您的工作流。首先使用 kanban 关键字启动图表。使用唯一的标识符和标题定义您的列以表示项目的不同阶段。在每个列下，列出您的任务（也使用唯一的标识符），并根据需要提供详细的描述。请记住，正确的缩进至关重要；任务必须缩进在其父列下以保持正确的结构。

您可以通过使用 @{ ... } 语法向任务添加可选元数据来增强您的图表，这使您可以包含其他上下文，例如被分配者、工单号和优先级级别。对于进一步的自定义，请使用文件顶部的配置块来设置全局选项，例如 ticketBaseUrl，以便直接从图表链接工单。

通过遵守这些指南——确保唯一的标识符、正确的缩进以及使用元数据和配置选项——您可以创建一个全面且自定义的 Kanban 看板，有效地使用 Mermaid 规划项目的流程。