Mermaid 看板图文档
Mermaid 的看板图允许您创建工作流中任务在不同阶段移动的视觉表示。本指南解释了如何使用看板图语法，以提供的示例为基础。
概述
Mermaid 中的看板图以 kanban 关键字开头，后面跟着列（阶段）和这些列中的任务的定义。
定义列
列代表您工作流中的不同阶段，例如“待办事项”、“进行中”、“已完成”等。每个列都使用唯一的标识符和方括号内的标题进行定义。
语法
columnId[Column Title]- columnId: 列的唯一标识符。
- [Column Title]: 在列标题上显示的标题。
例如 id1[待办事项]
向列中添加任务
任务以缩进的方式列在其各自的列下。每个任务也有一个唯一的标识符和方括号内的描述。
语法
taskId[Task Description]• taskId: A unique identifier for the task.
• [Task Description]: The description of the task.示例
docs[Create Documentation]向任务添加元数据
您可以使用 @{ ... } 语法为每个任务包含额外的元数据。元数据可以包含键值对，例如分配者、工单、优先级等。这将被渲染到节点的渲染中。
支持的元数据键
• 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 有效地映射出项目的工作流。