Mermaid 看板图文档
Mermaid的看板图允许您创建任务在工作流不同阶段移动的视觉表示。本指南基于提供的示例解释了如何使用看板图语法。
概述
Mermaid中的看板图以看板关键字开始，后面跟着列（阶段）和这些列中的任务的定义。
定义列
列代表您工作流程中的不同阶段，例如“待办”、“进行中”、“已完成”等。每个列都使用一个唯一的标识符和用方括号括起来的标题来定义。
语法:
columnId[Column Title]- columnId: 列的唯一标识符。
- [列标题]: 列标题上显示的标题。
像这样 id1[Todo]
将任务添加到列中
任务列在各自的列下，带有缩进。每个任务还有一个唯一的标识符和用方括号括起来的描述。
语法:
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映射出您项目的工作流程。