Skip to content
MermaidViewer

Planning diagram

Mermaid Kanban Board

Show work items as cards in columns such as To do, Doing and Done.

Basic kanban board example

Basic kanban board example diagram
mermaid
kanban
  todo[To do]
    t1[Write API docs]
    t2[Design pricing page]@{ priority: 'High' }
  doing[In progress]
    t3[AI diagram editor]@{ assigned: 'sam', ticket: MV-42 }
  review[Review]
    t4[Dark mode]
  done[Done]
    t5[Launch landing page]
Open in the live editor

Mermaid kanban diagrams render a board of columns and cards from an indented list. Each top-level item is a column; items indented beneath it are cards.

Cards can carry metadata like ticket ids, assignees and priority, which makes kanban diagrams a lightweight way to snapshot project status in docs and reports.

When to use a kanban board

  • Sprint status snapshots
  • Release checklists
  • Personal task boards
  • Roadmap status in READMEs

Kanban Board syntax reference

SyntaxWhat it does
kanbanStart a kanban board.
id[Column title]A column (top-level item).
id[Card text]A card (indented under a column).
@{ ticket: X, assigned: 'name', priority: 'High' }Card metadata.
priority: 'Very High' | 'High' | 'Low' | 'Very Low'Priority values.

Kanban Board examples

Tips and best practices

  • Give every column and card a unique id.
  • Use metadata sparingly — the board is a snapshot, not a full tracker.
  • Configure ticketBaseUrl to turn ticket ids into links.

Generate a kanban board with AI

Not sure where to start? Describe what you need and the AI kanban board generator writes the Mermaid code for you. Try prompts like:

  • “Kanban board for a website redesign”
  • “Content calendar board”
  • “Hiring pipeline board”

Kanban Board templates

Kanban Board FAQ

Can Mermaid kanban cards link to tickets?

Yes. Add ticket: ID to a card and set ticketBaseUrl in the kanban config (for example https://github.com/org/repo/issues/#TICKET#) to link each card.