| 6dd74de | | | 1 | > **Warning** |
| 6dd74de | | | 2 | > |
| 6dd74de | | | 3 | > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. |
| 6dd74de | | | 4 | > |
| 6dd74de | | | 5 | > ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/kanban.md](../../packages/mermaid/src/docs/syntax/kanban.md). |
| 6dd74de | | | 6 | |
| 6dd74de | | | 7 | # Mermaid Kanban Diagram Documentation |
| 6dd74de | | | 8 | |
| 6dd74de | | | 9 | Mermaid’s Kanban diagram allows you to create visual representations of tasks moving through different stages of a workflow. This guide explains how to use the Kanban diagram syntax, based on the provided example. |
| 6dd74de | | | 10 | |
| 6dd74de | | | 11 | ## Overview |
| 6dd74de | | | 12 | |
| 6dd74de | | | 13 | A Kanban diagram in Mermaid starts with the kanban keyword, followed by the definition of columns (stages) and tasks within those columns. |
| 6dd74de | | | 14 | |
| 6dd74de | | | 15 | ```mermaid-example |
| 6dd74de | | | 16 | kanban |
| 6dd74de | | | 17 | column1[Column Title] |
| 6dd74de | | | 18 | task1[Task Description] |
| 6dd74de | | | 19 | ``` |
| 6dd74de | | | 20 | |
| 6dd74de | | | 21 | ```mermaid |
| 6dd74de | | | 22 | kanban |
| 6dd74de | | | 23 | column1[Column Title] |
| 6dd74de | | | 24 | task1[Task Description] |
| 6dd74de | | | 25 | ``` |
| 6dd74de | | | 26 | |
| 6dd74de | | | 27 | ## Defining Columns |
| 6dd74de | | | 28 | |
| 6dd74de | | | 29 | Columns represent the different stages in your workflow, such as “Todo,” “In Progress,” “Done,” etc. Each column is defined using a unique identifier and a title enclosed in square brackets. |
| 6dd74de | | | 30 | |
| 6dd74de | | | 31 | **Syntax:** |
| 6dd74de | | | 32 | |
| 6dd74de | | | 33 | ``` |
| 6dd74de | | | 34 | columnId[Column Title] |
| 6dd74de | | | 35 | ``` |
| 6dd74de | | | 36 | |
| 6dd74de | | | 37 | - columnId: A unique identifier for the column. |
| 6dd74de | | | 38 | - \[Column Title]: The title displayed on the column header. |
| 6dd74de | | | 39 | |
| 6dd74de | | | 40 | Like this `id1[Todo]` |
| 6dd74de | | | 41 | |
| 6dd74de | | | 42 | ## Adding Tasks to Columns |
| 6dd74de | | | 43 | |
| 6dd74de | | | 44 | Tasks are listed under their respective columns with an indentation. Each task also has a unique identifier and a description enclosed in square brackets. |
| 6dd74de | | | 45 | |
| 6dd74de | | | 46 | **Syntax:** |
| 6dd74de | | | 47 | |
| 6dd74de | | | 48 | ``` |
| 6dd74de | | | 49 | taskId[Task Description] |
| 6dd74de | | | 50 | ``` |
| 6dd74de | | | 51 | |
| 6dd74de | | | 52 | ``` |
| 6dd74de | | | 53 | • taskId: A unique identifier for the task. |
| 6dd74de | | | 54 | • [Task Description]: The description of the task. |
| 6dd74de | | | 55 | ``` |
| 6dd74de | | | 56 | |
| 6dd74de | | | 57 | **Example:** |
| 6dd74de | | | 58 | |
| 6dd74de | | | 59 | ``` |
| 6dd74de | | | 60 | docs[Create Documentation] |
| 6dd74de | | | 61 | ``` |
| 6dd74de | | | 62 | |
| 6dd74de | | | 63 | ## Adding Metadata to Tasks |
| 6dd74de | | | 64 | |
| 6dd74de | | | 65 | You can include additional metadata for each task using the @{ ... } syntax. Metadata can contain key-value pairs like assigned, ticket, priority, etc. This will be rendered added to the rendering of the node. |
| 6dd74de | | | 66 | |
| 6dd74de | | | 67 | ## Supported Metadata Keys |
| 6dd74de | | | 68 | |
| 6dd74de | | | 69 | ``` |
| 6dd74de | | | 70 | • assigned: Specifies who is responsible for the task. |
| 6dd74de | | | 71 | • ticket: Links the task to a ticket or issue number. |
| 6dd74de | | | 72 | • priority: Indicates the urgency of the task. Allowed values: 'Very High', 'High', 'Low' and 'Very Low' |
| 6dd74de | | | 73 | ``` |
| 6dd74de | | | 74 | |
| 6dd74de | | | 75 | ```mermaid-example |
| 6dd74de | | | 76 | kanban |
| 6dd74de | | | 77 | todo[Todo] |
| 6dd74de | | | 78 | id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' } |
| 6dd74de | | | 79 | ``` |
| 6dd74de | | | 80 | |
| 6dd74de | | | 81 | ```mermaid |
| 6dd74de | | | 82 | kanban |
| 6dd74de | | | 83 | todo[Todo] |
| 6dd74de | | | 84 | id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' } |
| 6dd74de | | | 85 | ``` |
| 6dd74de | | | 86 | |
| 6dd74de | | | 87 | ## Configuration Options |
| 6dd74de | | | 88 | |
| 6dd74de | | | 89 | You can customize the Kanban diagram using a configuration block at the beginning of your markdown file. This is useful for setting global settings like a base URL for tickets. Currently there is one configuration option for kanban diagrams `ticketBaseUrl`. This can be set as in the following example: |
| 6dd74de | | | 90 | |
| 6dd74de | | | 91 | ```yaml |
| 6dd74de | | | 92 | --- |
| 6dd74de | | | 93 | config: |
| 6dd74de | | | 94 | kanban: |
| 6dd74de | | | 95 | ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#' |
| 6dd74de | | | 96 | --- |
| 6dd74de | | | 97 | ``` |
| 6dd74de | | | 98 | |
| 6dd74de | | | 99 | When the kanban item has an assigned ticket number the ticket number in the diagram will have a link to an external system where the ticket is defined. The `ticketBaseUrl` sets the base URL to the external system and #TICKET# is replaced with the ticket value from task metadata to create a valid link. |
| 6dd74de | | | 100 | |
| 6dd74de | | | 101 | ## Full Example |
| 6dd74de | | | 102 | |
| 6dd74de | | | 103 | Below is the full Kanban diagram based on the provided example: |
| 6dd74de | | | 104 | |
| 6dd74de | | | 105 | ```mermaid-example |
| 6dd74de | | | 106 | --- |
| 6dd74de | | | 107 | config: |
| 6dd74de | | | 108 | kanban: |
| 6dd74de | | | 109 | ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#' |
| 6dd74de | | | 110 | --- |
| 6dd74de | | | 111 | kanban |
| 6dd74de | | | 112 | Todo |
| 6dd74de | | | 113 | [Create Documentation] |
| 6dd74de | | | 114 | docs[Create Blog about the new diagram] |
| 6dd74de | | | 115 | [In progress] |
| 6dd74de | | | 116 | id6[Create renderer so that it works in all cases. We also add some extra text here for testing purposes. And some more just for the extra flare.] |
| 6dd74de | | | 117 | id9[Ready for deploy] |
| 6dd74de | | | 118 | id8[Design grammar]@{ assigned: 'knsv' } |
| 6dd74de | | | 119 | id10[Ready for test] |
| 6dd74de | | | 120 | id4[Create parsing tests]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: 'High' } |
| 6dd74de | | | 121 | id66[last item]@{ priority: 'Very Low', assigned: 'knsv' } |
| 6dd74de | | | 122 | id11[Done] |
| 6dd74de | | | 123 | id5[define getData] |
| 6dd74de | | | 124 | id2[Title of diagram is more than 100 chars when user duplicates diagram with 100 char]@{ ticket: MC-2036, priority: 'Very High'} |
| 6dd74de | | | 125 | id3[Update DB function]@{ ticket: MC-2037, assigned: knsv, priority: 'High' } |
| 6dd74de | | | 126 | |
| 6dd74de | | | 127 | id12[Can't reproduce] |
| 6dd74de | | | 128 | id3[Weird flickering in Firefox] |
| 6dd74de | | | 129 | ``` |
| 6dd74de | | | 130 | |
| 6dd74de | | | 131 | ```mermaid |
| 6dd74de | | | 132 | --- |
| 6dd74de | | | 133 | config: |
| 6dd74de | | | 134 | kanban: |
| 6dd74de | | | 135 | ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#' |
| 6dd74de | | | 136 | --- |
| 6dd74de | | | 137 | kanban |
| 6dd74de | | | 138 | Todo |
| 6dd74de | | | 139 | [Create Documentation] |
| 6dd74de | | | 140 | docs[Create Blog about the new diagram] |
| 6dd74de | | | 141 | [In progress] |
| 6dd74de | | | 142 | id6[Create renderer so that it works in all cases. We also add some extra text here for testing purposes. And some more just for the extra flare.] |
| 6dd74de | | | 143 | id9[Ready for deploy] |
| 6dd74de | | | 144 | id8[Design grammar]@{ assigned: 'knsv' } |
| 6dd74de | | | 145 | id10[Ready for test] |
| 6dd74de | | | 146 | id4[Create parsing tests]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: 'High' } |
| 6dd74de | | | 147 | id66[last item]@{ priority: 'Very Low', assigned: 'knsv' } |
| 6dd74de | | | 148 | id11[Done] |
| 6dd74de | | | 149 | id5[define getData] |
| 6dd74de | | | 150 | id2[Title of diagram is more than 100 chars when user duplicates diagram with 100 char]@{ ticket: MC-2036, priority: 'Very High'} |
| 6dd74de | | | 151 | id3[Update DB function]@{ ticket: MC-2037, assigned: knsv, priority: 'High' } |
| 6dd74de | | | 152 | |
| 6dd74de | | | 153 | id12[Can't reproduce] |
| 6dd74de | | | 154 | id3[Weird flickering in Firefox] |
| 6dd74de | | | 155 | ``` |
| 6dd74de | | | 156 | |
| 6dd74de | | | 157 | In conclusion, creating a Kanban diagram in Mermaid is a straightforward process that effectively visualizes your workflow. Start by using the kanban keyword to initiate the diagram. Define your columns with unique identifiers and titles to represent different stages of your project. Under each column, list your tasks—also with unique identifiers—and provide detailed descriptions as needed. Remember that proper indentation is crucial; tasks must be indented under their parent columns to maintain the correct structure. |
| 6dd74de | | | 158 | |
| 6dd74de | | | 159 | You can enhance your diagram by adding optional metadata to tasks using the @{ ... } syntax, which allows you to include additional context such as assignee, ticket numbers, and priority levels. For further customization, utilize the configuration block at the top of your file to set global options like ticketBaseUrl for linking tickets directly from your diagram. |
| 6dd74de | | | 160 | |
| 6dd74de | | | 161 | By adhering to these guidelines—ensuring unique identifiers, proper indentation, and utilizing metadata and configuration options—you can create a comprehensive and customized Kanban board that effectively maps out your project’s workflow using Mermaid. |