Mermaid Kanban Boards

Mermaid Native Kanban Boards (kanban) allow you to build agile project boards natively. Introduced in modern versions of Mermaid, this dedicated type structures workflows using clean columns, tasks, and item metadata without needing to hack standard flowchart subgraphs.

Kanban diagrams can represent work items inside documentation.

Typical columns are:

• Todo
• In Progress
• Done

Core Syntax Structure

A Kanban diagram initializes with the kanban keyword. Columns represent the stages of a process, and tasks are defined as child nodes nested under those columns via indentation.

• Columns: Defined using a unique identifier and bracket text: columnId[Column Title].
• Tasks: Defined as nested items with unique identifiers: taskId[Task Description].
• Indentation: Proper spacing under a column header is mandatory for Mermaid to pair tasks with their parent column.

Task Metadata Configurations (@{ ... })

You can enrich individual tasks by adding explicit metadata tags right below the task line using the @{ ... } block parameter.

The parser natively understands these parameters:

• assigned: The name or username of the task assignee.
• ticket: The reference issue identifier or tracking number.
• priority: Sets urgency color highlights. Allowed options include: 'Very High', 'High', 'Low', and 'Very Low'.

Small Kanban Example

kanban
    Todo
        [API Docs]
        [Setup CI/CD]

    In Progress
        [Database Migration] @{assign: "John"}

    Done
        [Auth Module]

Kanban is useful for lightweight issue and task tracking.