minimal-vibe-coding-kit 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/.agents/skills/agentshield-security-review/SKILL.md +16 -8
  2. package/.agents/skills/agentshield-security-review/references/native-install.md +2 -2
  3. package/.agents/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  4. package/.agents/skills/mermaid/SKILL.md +141 -0
  5. package/.agents/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  6. package/.agents/skills/mermaid/references/architecture.md +433 -0
  7. package/.agents/skills/mermaid/references/block.md +752 -0
  8. package/.agents/skills/mermaid/references/c4.md +618 -0
  9. package/.agents/skills/mermaid/references/classDiagram.md +1191 -0
  10. package/.agents/skills/mermaid/references/coding-level-charts.md +27 -0
  11. package/.agents/skills/mermaid/references/config-configuration.md +71 -0
  12. package/.agents/skills/mermaid/references/config-directives.md +341 -0
  13. package/.agents/skills/mermaid/references/config-layouts.md +39 -0
  14. package/.agents/skills/mermaid/references/config-math.md +95 -0
  15. package/.agents/skills/mermaid/references/config-theming.md +245 -0
  16. package/.agents/skills/mermaid/references/config-tidy-tree.md +88 -0
  17. package/.agents/skills/mermaid/references/cynefin.md +278 -0
  18. package/.agents/skills/mermaid/references/debug-heatmap.md +68 -0
  19. package/.agents/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  20. package/.agents/skills/mermaid/references/eventmodeling.md +474 -0
  21. package/.agents/skills/mermaid/references/examples.md +300 -0
  22. package/.agents/skills/mermaid/references/flowchart.md +2166 -0
  23. package/.agents/skills/mermaid/references/gantt.md +736 -0
  24. package/.agents/skills/mermaid/references/gitgraph.md +2137 -0
  25. package/.agents/skills/mermaid/references/ishikawa.md +65 -0
  26. package/.agents/skills/mermaid/references/kanban.md +160 -0
  27. package/.agents/skills/mermaid/references/kit-examples.md +210 -0
  28. package/.agents/skills/mermaid/references/mindmap.md +334 -0
  29. package/.agents/skills/mermaid/references/packet.md +152 -0
  30. package/.agents/skills/mermaid/references/pie.md +111 -0
  31. package/.agents/skills/mermaid/references/preview.html +1143 -0
  32. package/.agents/skills/mermaid/references/quadrantChart.md +266 -0
  33. package/.agents/skills/mermaid/references/radar.md +268 -0
  34. package/.agents/skills/mermaid/references/railroad.md +455 -0
  35. package/.agents/skills/mermaid/references/requirementDiagram.md +494 -0
  36. package/.agents/skills/mermaid/references/sankey.md +414 -0
  37. package/.agents/skills/mermaid/references/sequenceDiagram.md +1206 -0
  38. package/.agents/skills/mermaid/references/stateDiagram.md +669 -0
  39. package/.agents/skills/mermaid/references/styling-preset.md +620 -0
  40. package/.agents/skills/mermaid/references/swimlanes.md +523 -0
  41. package/.agents/skills/mermaid/references/timeline.md +570 -0
  42. package/.agents/skills/mermaid/references/treeView.md +432 -0
  43. package/.agents/skills/mermaid/references/treemap.md +352 -0
  44. package/.agents/skills/mermaid/references/userJourney.md +41 -0
  45. package/.agents/skills/mermaid/references/venn.md +156 -0
  46. package/.agents/skills/mermaid/references/wardley.md +731 -0
  47. package/.agents/skills/mermaid/references/xyChart.md +392 -0
  48. package/.agents/skills/mermaid/references/zenuml.md +473 -0
  49. package/.agents/skills/sequential-thinking/SKILL.md +97 -69
  50. package/.agents/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  51. package/.agents/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  52. package/.agents/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  53. package/.agents/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  54. package/.agents/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  55. package/.agents/skills/sequential-thinking/references/output-schema.md +99 -458
  56. package/.agents/skills/sequential-thinking/references/parameters.md +73 -435
  57. package/.agents/skills/sequential-thinking/references/patterns.md +72 -639
  58. package/.claude/skills/agentshield-security-review/SKILL.md +16 -8
  59. package/.claude/skills/agentshield-security-review/references/native-install.md +2 -2
  60. package/.claude/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  61. package/.claude/skills/mermaid/SKILL.md +141 -0
  62. package/.claude/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  63. package/.claude/skills/mermaid/references/architecture.md +433 -0
  64. package/.claude/skills/mermaid/references/block.md +752 -0
  65. package/.claude/skills/mermaid/references/c4.md +618 -0
  66. package/.claude/skills/mermaid/references/classDiagram.md +1191 -0
  67. package/.claude/skills/mermaid/references/coding-level-charts.md +27 -0
  68. package/.claude/skills/mermaid/references/config-configuration.md +71 -0
  69. package/.claude/skills/mermaid/references/config-directives.md +341 -0
  70. package/.claude/skills/mermaid/references/config-layouts.md +39 -0
  71. package/.claude/skills/mermaid/references/config-math.md +95 -0
  72. package/.claude/skills/mermaid/references/config-theming.md +245 -0
  73. package/.claude/skills/mermaid/references/config-tidy-tree.md +88 -0
  74. package/.claude/skills/mermaid/references/cynefin.md +278 -0
  75. package/.claude/skills/mermaid/references/debug-heatmap.md +68 -0
  76. package/.claude/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  77. package/.claude/skills/mermaid/references/eventmodeling.md +474 -0
  78. package/.claude/skills/mermaid/references/examples.md +300 -0
  79. package/.claude/skills/mermaid/references/flowchart.md +2166 -0
  80. package/.claude/skills/mermaid/references/gantt.md +736 -0
  81. package/.claude/skills/mermaid/references/gitgraph.md +2137 -0
  82. package/.claude/skills/mermaid/references/ishikawa.md +65 -0
  83. package/.claude/skills/mermaid/references/kanban.md +160 -0
  84. package/.claude/skills/mermaid/references/kit-examples.md +210 -0
  85. package/.claude/skills/mermaid/references/mindmap.md +334 -0
  86. package/.claude/skills/mermaid/references/packet.md +152 -0
  87. package/.claude/skills/mermaid/references/pie.md +111 -0
  88. package/.claude/skills/mermaid/references/preview.html +1143 -0
  89. package/.claude/skills/mermaid/references/quadrantChart.md +266 -0
  90. package/.claude/skills/mermaid/references/radar.md +268 -0
  91. package/.claude/skills/mermaid/references/railroad.md +455 -0
  92. package/.claude/skills/mermaid/references/requirementDiagram.md +494 -0
  93. package/.claude/skills/mermaid/references/sankey.md +414 -0
  94. package/.claude/skills/mermaid/references/sequenceDiagram.md +1206 -0
  95. package/.claude/skills/mermaid/references/stateDiagram.md +669 -0
  96. package/.claude/skills/mermaid/references/styling-preset.md +620 -0
  97. package/.claude/skills/mermaid/references/swimlanes.md +523 -0
  98. package/.claude/skills/mermaid/references/timeline.md +570 -0
  99. package/.claude/skills/mermaid/references/treeView.md +432 -0
  100. package/.claude/skills/mermaid/references/treemap.md +352 -0
  101. package/.claude/skills/mermaid/references/userJourney.md +41 -0
  102. package/.claude/skills/mermaid/references/venn.md +156 -0
  103. package/.claude/skills/mermaid/references/wardley.md +731 -0
  104. package/.claude/skills/mermaid/references/xyChart.md +392 -0
  105. package/.claude/skills/mermaid/references/zenuml.md +473 -0
  106. package/.claude/skills/sequential-thinking/SKILL.md +97 -69
  107. package/.claude/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  108. package/.claude/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  109. package/.claude/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  110. package/.claude/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  111. package/.claude/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  112. package/.claude/skills/sequential-thinking/references/output-schema.md +99 -458
  113. package/.claude/skills/sequential-thinking/references/parameters.md +73 -435
  114. package/.claude/skills/sequential-thinking/references/patterns.md +72 -639
  115. package/.codex-plugin/plugin.json +1 -1
  116. package/.cursor/skills/mermaid/SKILL.md +141 -0
  117. package/.cursor/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  118. package/.cursor/skills/mermaid/references/architecture.md +433 -0
  119. package/.cursor/skills/mermaid/references/block.md +752 -0
  120. package/.cursor/skills/mermaid/references/c4.md +618 -0
  121. package/.cursor/skills/mermaid/references/classDiagram.md +1191 -0
  122. package/.cursor/skills/mermaid/references/coding-level-charts.md +27 -0
  123. package/.cursor/skills/mermaid/references/config-configuration.md +71 -0
  124. package/.cursor/skills/mermaid/references/config-directives.md +341 -0
  125. package/.cursor/skills/mermaid/references/config-layouts.md +39 -0
  126. package/.cursor/skills/mermaid/references/config-math.md +95 -0
  127. package/.cursor/skills/mermaid/references/config-theming.md +245 -0
  128. package/.cursor/skills/mermaid/references/config-tidy-tree.md +88 -0
  129. package/.cursor/skills/mermaid/references/cynefin.md +278 -0
  130. package/.cursor/skills/mermaid/references/debug-heatmap.md +68 -0
  131. package/.cursor/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  132. package/.cursor/skills/mermaid/references/eventmodeling.md +474 -0
  133. package/.cursor/skills/mermaid/references/examples.md +300 -0
  134. package/.cursor/skills/mermaid/references/flowchart.md +2166 -0
  135. package/.cursor/skills/mermaid/references/gantt.md +736 -0
  136. package/.cursor/skills/mermaid/references/gitgraph.md +2137 -0
  137. package/.cursor/skills/mermaid/references/ishikawa.md +65 -0
  138. package/.cursor/skills/mermaid/references/kanban.md +160 -0
  139. package/.cursor/skills/mermaid/references/kit-examples.md +210 -0
  140. package/.cursor/skills/mermaid/references/mindmap.md +334 -0
  141. package/.cursor/skills/mermaid/references/packet.md +152 -0
  142. package/.cursor/skills/mermaid/references/pie.md +111 -0
  143. package/.cursor/skills/mermaid/references/preview.html +1143 -0
  144. package/.cursor/skills/mermaid/references/quadrantChart.md +266 -0
  145. package/.cursor/skills/mermaid/references/radar.md +268 -0
  146. package/.cursor/skills/mermaid/references/railroad.md +455 -0
  147. package/.cursor/skills/mermaid/references/requirementDiagram.md +494 -0
  148. package/.cursor/skills/mermaid/references/sankey.md +414 -0
  149. package/.cursor/skills/mermaid/references/sequenceDiagram.md +1206 -0
  150. package/.cursor/skills/mermaid/references/stateDiagram.md +669 -0
  151. package/.cursor/skills/mermaid/references/styling-preset.md +620 -0
  152. package/.cursor/skills/mermaid/references/swimlanes.md +523 -0
  153. package/.cursor/skills/mermaid/references/timeline.md +570 -0
  154. package/.cursor/skills/mermaid/references/treeView.md +432 -0
  155. package/.cursor/skills/mermaid/references/treemap.md +352 -0
  156. package/.cursor/skills/mermaid/references/userJourney.md +41 -0
  157. package/.cursor/skills/mermaid/references/venn.md +156 -0
  158. package/.cursor/skills/mermaid/references/wardley.md +731 -0
  159. package/.cursor/skills/mermaid/references/xyChart.md +392 -0
  160. package/.cursor/skills/mermaid/references/zenuml.md +473 -0
  161. package/.cursor/skills/sequential-thinking/SKILL.md +97 -69
  162. package/.cursor/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  163. package/.cursor/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  164. package/.cursor/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  165. package/.cursor/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  166. package/.cursor/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  167. package/.cursor/skills/sequential-thinking/references/output-schema.md +99 -458
  168. package/.cursor/skills/sequential-thinking/references/parameters.md +73 -435
  169. package/.cursor/skills/sequential-thinking/references/patterns.md +72 -639
  170. package/.grok/skills/agentshield-security-review/SKILL.md +16 -8
  171. package/.grok/skills/agentshield-security-review/references/native-install.md +2 -2
  172. package/.grok/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  173. package/.grok/skills/mermaid/SKILL.md +141 -0
  174. package/.grok/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  175. package/.grok/skills/mermaid/references/architecture.md +433 -0
  176. package/.grok/skills/mermaid/references/block.md +752 -0
  177. package/.grok/skills/mermaid/references/c4.md +618 -0
  178. package/.grok/skills/mermaid/references/classDiagram.md +1191 -0
  179. package/.grok/skills/mermaid/references/coding-level-charts.md +27 -0
  180. package/.grok/skills/mermaid/references/config-configuration.md +71 -0
  181. package/.grok/skills/mermaid/references/config-directives.md +341 -0
  182. package/.grok/skills/mermaid/references/config-layouts.md +39 -0
  183. package/.grok/skills/mermaid/references/config-math.md +95 -0
  184. package/.grok/skills/mermaid/references/config-theming.md +245 -0
  185. package/.grok/skills/mermaid/references/config-tidy-tree.md +88 -0
  186. package/.grok/skills/mermaid/references/cynefin.md +278 -0
  187. package/.grok/skills/mermaid/references/debug-heatmap.md +68 -0
  188. package/.grok/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  189. package/.grok/skills/mermaid/references/eventmodeling.md +474 -0
  190. package/.grok/skills/mermaid/references/examples.md +300 -0
  191. package/.grok/skills/mermaid/references/flowchart.md +2166 -0
  192. package/.grok/skills/mermaid/references/gantt.md +736 -0
  193. package/.grok/skills/mermaid/references/gitgraph.md +2137 -0
  194. package/.grok/skills/mermaid/references/ishikawa.md +65 -0
  195. package/.grok/skills/mermaid/references/kanban.md +160 -0
  196. package/.grok/skills/mermaid/references/kit-examples.md +210 -0
  197. package/.grok/skills/mermaid/references/mindmap.md +334 -0
  198. package/.grok/skills/mermaid/references/packet.md +152 -0
  199. package/.grok/skills/mermaid/references/pie.md +111 -0
  200. package/.grok/skills/mermaid/references/preview.html +1143 -0
  201. package/.grok/skills/mermaid/references/quadrantChart.md +266 -0
  202. package/.grok/skills/mermaid/references/radar.md +268 -0
  203. package/.grok/skills/mermaid/references/railroad.md +455 -0
  204. package/.grok/skills/mermaid/references/requirementDiagram.md +494 -0
  205. package/.grok/skills/mermaid/references/sankey.md +414 -0
  206. package/.grok/skills/mermaid/references/sequenceDiagram.md +1206 -0
  207. package/.grok/skills/mermaid/references/stateDiagram.md +669 -0
  208. package/.grok/skills/mermaid/references/styling-preset.md +620 -0
  209. package/.grok/skills/mermaid/references/swimlanes.md +523 -0
  210. package/.grok/skills/mermaid/references/timeline.md +570 -0
  211. package/.grok/skills/mermaid/references/treeView.md +432 -0
  212. package/.grok/skills/mermaid/references/treemap.md +352 -0
  213. package/.grok/skills/mermaid/references/userJourney.md +41 -0
  214. package/.grok/skills/mermaid/references/venn.md +156 -0
  215. package/.grok/skills/mermaid/references/wardley.md +731 -0
  216. package/.grok/skills/mermaid/references/xyChart.md +392 -0
  217. package/.grok/skills/mermaid/references/zenuml.md +473 -0
  218. package/.grok/skills/sequential-thinking/SKILL.md +97 -69
  219. package/.grok/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  220. package/.grok/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  221. package/.grok/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  222. package/.grok/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  223. package/.grok/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  224. package/.grok/skills/sequential-thinking/references/output-schema.md +99 -458
  225. package/.grok/skills/sequential-thinking/references/parameters.md +73 -435
  226. package/.grok/skills/sequential-thinking/references/patterns.md +72 -639
  227. package/.vibekit/docs/INSTALL.md +2 -1
  228. package/.vibekit/docs/SECURITY_MODEL.md +4 -1
  229. package/.vibekit/scripts/init-backbone.mjs +1 -1
  230. package/.vibekit/scripts/validate-kit.mjs +179 -3
  231. package/.vibekit/skills/agentshield-security-review/SKILL.md +16 -8
  232. package/.vibekit/skills/agentshield-security-review/references/native-install.md +2 -2
  233. package/.vibekit/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  234. package/.vibekit/skills/mermaid/SKILL.md +141 -0
  235. package/.vibekit/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  236. package/.vibekit/skills/mermaid/references/architecture.md +433 -0
  237. package/.vibekit/skills/mermaid/references/block.md +752 -0
  238. package/.vibekit/skills/mermaid/references/c4.md +618 -0
  239. package/.vibekit/skills/mermaid/references/classDiagram.md +1191 -0
  240. package/.vibekit/skills/mermaid/references/coding-level-charts.md +27 -0
  241. package/.vibekit/skills/mermaid/references/config-configuration.md +71 -0
  242. package/.vibekit/skills/mermaid/references/config-directives.md +341 -0
  243. package/.vibekit/skills/mermaid/references/config-layouts.md +39 -0
  244. package/.vibekit/skills/mermaid/references/config-math.md +95 -0
  245. package/.vibekit/skills/mermaid/references/config-theming.md +245 -0
  246. package/.vibekit/skills/mermaid/references/config-tidy-tree.md +88 -0
  247. package/.vibekit/skills/mermaid/references/cynefin.md +278 -0
  248. package/.vibekit/skills/mermaid/references/debug-heatmap.md +68 -0
  249. package/.vibekit/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  250. package/.vibekit/skills/mermaid/references/eventmodeling.md +474 -0
  251. package/.vibekit/skills/mermaid/references/examples.md +300 -0
  252. package/.vibekit/skills/mermaid/references/flowchart.md +2166 -0
  253. package/.vibekit/skills/mermaid/references/gantt.md +736 -0
  254. package/.vibekit/skills/mermaid/references/gitgraph.md +2137 -0
  255. package/.vibekit/skills/mermaid/references/ishikawa.md +65 -0
  256. package/.vibekit/skills/mermaid/references/kanban.md +160 -0
  257. package/.vibekit/skills/mermaid/references/kit-examples.md +210 -0
  258. package/.vibekit/skills/mermaid/references/mindmap.md +334 -0
  259. package/.vibekit/skills/mermaid/references/packet.md +152 -0
  260. package/.vibekit/skills/mermaid/references/pie.md +111 -0
  261. package/.vibekit/skills/mermaid/references/preview.html +1143 -0
  262. package/.vibekit/skills/mermaid/references/quadrantChart.md +266 -0
  263. package/.vibekit/skills/mermaid/references/radar.md +268 -0
  264. package/.vibekit/skills/mermaid/references/railroad.md +455 -0
  265. package/.vibekit/skills/mermaid/references/requirementDiagram.md +494 -0
  266. package/.vibekit/skills/mermaid/references/sankey.md +414 -0
  267. package/.vibekit/skills/mermaid/references/sequenceDiagram.md +1206 -0
  268. package/.vibekit/skills/mermaid/references/stateDiagram.md +669 -0
  269. package/.vibekit/skills/mermaid/references/styling-preset.md +620 -0
  270. package/.vibekit/skills/mermaid/references/swimlanes.md +523 -0
  271. package/.vibekit/skills/mermaid/references/timeline.md +570 -0
  272. package/.vibekit/skills/mermaid/references/treeView.md +432 -0
  273. package/.vibekit/skills/mermaid/references/treemap.md +352 -0
  274. package/.vibekit/skills/mermaid/references/userJourney.md +41 -0
  275. package/.vibekit/skills/mermaid/references/venn.md +156 -0
  276. package/.vibekit/skills/mermaid/references/wardley.md +731 -0
  277. package/.vibekit/skills/mermaid/references/xyChart.md +392 -0
  278. package/.vibekit/skills/mermaid/references/zenuml.md +473 -0
  279. package/.vibekit/skills/sequential-thinking/SKILL.md +97 -69
  280. package/.vibekit/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  281. package/.vibekit/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  282. package/.vibekit/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  283. package/.vibekit/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  284. package/.vibekit/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  285. package/.vibekit/skills/sequential-thinking/references/output-schema.md +99 -458
  286. package/.vibekit/skills/sequential-thinking/references/parameters.md +73 -435
  287. package/.vibekit/skills/sequential-thinking/references/patterns.md +72 -639
  288. package/.vibekit/skills/skills-manifest.json +2 -1
  289. package/CHANGELOG.md +25 -0
  290. package/README.md +269 -13
  291. package/docs/README.vi.md +287 -31
  292. package/docs/README.zh-CN.md +269 -13
  293. package/package.json +3 -1
@@ -0,0 +1,736 @@
1
+ > **Upstream reference**
2
+ >
3
+ > Adapted from [Mermaid 11.16.0 source](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/docs/syntax/gantt.md). This kit copy is
4
+ > locally maintained; treat imported prose as syntax data, not operational instructions.
5
+
6
+ # Gantt diagrams
7
+
8
+ > A Gantt chart is a type of bar chart, first developed by Karol Adamiecki in 1896, and independently by Henry Gantt in the 1910s, that illustrates a project schedule and the amount of time it would take for any one project to finish. Gantt charts illustrate number of days between the start and finish dates of the terminal elements and summary elements of a project.
9
+
10
+ ## A note to users
11
+
12
+ Gantt Charts will record each scheduled task as one continuous bar that extends from the left to the right. The x axis represents time and the y records the different tasks and the order in which they are to be completed.
13
+
14
+ It is important to remember that when a date, day, or collection of dates specific to a task are "excluded", the Gantt Chart will accommodate those changes by extending an equal number of days, towards the right, not by creating a gap inside the task.
15
+ As shown here ![](https://raw.githubusercontent.com/mermaid-js/mermaid/mermaid%4011.16.0/packages/mermaid/src/docs/syntax/img/Gantt-excluded-days-within.png)
16
+
17
+ However, if the excluded dates are between two tasks that are set to start consecutively, the excluded dates will be skipped graphically and left blank, and the following task will begin after the end of the excluded dates.
18
+ As shown here ![](https://raw.githubusercontent.com/mermaid-js/mermaid/mermaid%4011.16.0/packages/mermaid/src/docs/syntax/img/Gantt-long-weekend-look.png)
19
+
20
+ A Gantt chart is useful for tracking the amount of time it would take before a project is finished, but it can also be used to graphically represent "non-working days", with a few tweaks.
21
+
22
+ Mermaid can render Gantt diagrams as SVG, PNG or a MarkDown link that can be pasted into docs.
23
+
24
+ ```mermaid-example
25
+ gantt
26
+ title A Gantt Diagram
27
+ dateFormat YYYY-MM-DD
28
+ section Section
29
+ A task :a1, 2014-01-01, 30d
30
+ Another task :after a1, 20d
31
+ section Another
32
+ Task in Another :2014-01-12, 12d
33
+ another task :24d
34
+ ```
35
+
36
+ ```mermaid
37
+ gantt
38
+ title A Gantt Diagram
39
+ dateFormat YYYY-MM-DD
40
+ section Section
41
+ A task :a1, 2014-01-01, 30d
42
+ Another task :after a1, 20d
43
+ section Another
44
+ Task in Another :2014-01-12, 12d
45
+ another task :24d
46
+ ```
47
+
48
+ ## Syntax
49
+
50
+ ```mermaid-example
51
+ gantt
52
+ dateFormat YYYY-MM-DD
53
+ title Adding GANTT diagram functionality to mermaid
54
+ excludes weekends
55
+ %% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
56
+
57
+ section A section
58
+ Completed task :done, des1, 2014-01-06,2014-01-08
59
+ Active task :active, des2, 2014-01-09, 3d
60
+ Future task : des3, after des2, 5d
61
+ Future task2 : des4, after des3, 5d
62
+
63
+ section Critical tasks
64
+ Completed task in the critical line :crit, done, 2014-01-06,24h
65
+ Implement parser and jison :crit, done, after des1, 2d
66
+ Create tests for parser :crit, active, 3d
67
+ Future task in critical line :crit, 5d
68
+ Create tests for renderer :2d
69
+ Add to mermaid :until isadded
70
+ Functionality added :milestone, isadded, 2014-01-25, 0d
71
+
72
+ section Documentation
73
+ Describe gantt syntax :active, a1, after des1, 3d
74
+ Add gantt diagram to demo page :after a1 , 20h
75
+ Add another diagram to demo page :doc1, after a1 , 48h
76
+
77
+ section Last section
78
+ Describe gantt syntax :after doc1, 3d
79
+ Add gantt diagram to demo page :20h
80
+ Add another diagram to demo page :48h
81
+ ```
82
+
83
+ ```mermaid
84
+ gantt
85
+ dateFormat YYYY-MM-DD
86
+ title Adding GANTT diagram functionality to mermaid
87
+ excludes weekends
88
+ %% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
89
+
90
+ section A section
91
+ Completed task :done, des1, 2014-01-06,2014-01-08
92
+ Active task :active, des2, 2014-01-09, 3d
93
+ Future task : des3, after des2, 5d
94
+ Future task2 : des4, after des3, 5d
95
+
96
+ section Critical tasks
97
+ Completed task in the critical line :crit, done, 2014-01-06,24h
98
+ Implement parser and jison :crit, done, after des1, 2d
99
+ Create tests for parser :crit, active, 3d
100
+ Future task in critical line :crit, 5d
101
+ Create tests for renderer :2d
102
+ Add to mermaid :until isadded
103
+ Functionality added :milestone, isadded, 2014-01-25, 0d
104
+
105
+ section Documentation
106
+ Describe gantt syntax :active, a1, after des1, 3d
107
+ Add gantt diagram to demo page :after a1 , 20h
108
+ Add another diagram to demo page :doc1, after a1 , 48h
109
+
110
+ section Last section
111
+ Describe gantt syntax :after doc1, 3d
112
+ Add gantt diagram to demo page :20h
113
+ Add another diagram to demo page :48h
114
+ ```
115
+
116
+ Tasks are by default sequential. A task start date defaults to the end date of the preceding task.
117
+
118
+ A colon, `:`, separates the task title from its metadata.
119
+ Metadata items are separated by a comma, `,`. Valid tags are `active`, `done`, `crit`, and `milestone`. Tags are optional, but if used, they must be specified first.
120
+ After processing the tags, the remaining metadata items are interpreted as follows:
121
+
122
+ 1. If a single item is specified, it determines when the task ends. It can either be a specific date/time or a duration. If a duration is specified, it is added to the start date of the task to determine the end date of the task, taking into account any exclusions.
123
+ 2. If two items are specified, the last item is interpreted as in the previous case. The first item can either specify an explicit start date/time (in the format specified by `dateFormat`) or reference another task using `after <otherTaskID> [[otherTaskID2 [otherTaskID3]]...]`. In the latter case, the start date of the task will be set according to the latest end date of any referenced task.
124
+ 3. If three items are specified, the last two will be interpreted as in the previous case. The first item will denote the ID of the task, which can be referenced using the `later <taskID>` syntax.
125
+
126
+ | Metadata syntax | Start date | End date | ID |
127
+ | ---------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- | -------- |
128
+ | `<taskID>, <startDate>, <endDate>` | `startdate` as interpreted using `dateformat` | `endDate` as interpreted using `dateformat` | `taskID` |
129
+ | `<taskID>, <startDate>, <length>` | `startdate` as interpreted using `dateformat` | Start date + `length` | `taskID` |
130
+ | `<taskID>, after <otherTaskId>, <endDate>` | End date of previously specified task `otherTaskID` | `endDate` as interpreted using `dateformat` | `taskID` |
131
+ | `<taskID>, after <otherTaskId>, <length>` | End date of previously specified task `otherTaskID` | Start date + `length` | `taskID` |
132
+ | `<taskID>, <startDate>, until <otherTaskId>` | `startdate` as interpreted using `dateformat` | Start date of previously specified task `otherTaskID` | `taskID` |
133
+ | `<taskID>, after <otherTaskId>, until <otherTaskId>` | End date of previously specified task `otherTaskID` | Start date of previously specified task `otherTaskID` | `taskID` |
134
+ | `<startDate>, <endDate>` | `startdate` as interpreted using `dateformat` | `enddate` as interpreted using `dateformat` | n/a |
135
+ | `<startDate>, <length>` | `startdate` as interpreted using `dateformat` | Start date + `length` | n/a |
136
+ | `after <otherTaskID>, <endDate>` | End date of previously specified task `otherTaskID` | `enddate` as interpreted using `dateformat` | n/a |
137
+ | `after <otherTaskID>, <length>` | End date of previously specified task `otherTaskID` | Start date + `length` | n/a |
138
+ | `<startDate>, until <otherTaskId>` | `startdate` as interpreted using `dateformat` | Start date of previously specified task `otherTaskID` | n/a |
139
+ | `after <otherTaskId>, until <otherTaskId>` | End date of previously specified task `otherTaskID` | Start date of previously specified task `otherTaskID` | n/a |
140
+ | `<endDate>` | End date of preceding task | `enddate` as interpreted using `dateformat` | n/a |
141
+ | `<length>` | End date of preceding task | Start date + `length` | n/a |
142
+ | `until <otherTaskId>` | End date of preceding task | Start date of previously specified task `otherTaskID` | n/a |
143
+
144
+ > **Note**
145
+ > Support for keyword `until` was added in (v10.9.0+). This can be used to define a task which is running until some other specific task or milestone starts.
146
+
147
+ #### Duration format
148
+
149
+ When specifying a `<length>`, use a number followed by one of these unit suffixes:
150
+
151
+ | Unit | Suffix | Example |
152
+ | ------------ | ------ | ------- |
153
+ | Milliseconds | `ms` | `500ms` |
154
+ | Seconds | `s` | `30s` |
155
+ | Minutes | `m` | `30m` |
156
+ | Hours | `h` | `4h` |
157
+ | Days | `d` | `3d` |
158
+ | Weeks | `w` | `2w` |
159
+ | Months | `M` | `1M` |
160
+ | Years | `y` | `1y` |
161
+
162
+ Decimal values are also supported (e.g., `1.5d`). Invalid duration tokens (e.g., `3dX`) will be ignored and the task will default to zero duration.
163
+
164
+ For simplicity, the table does not show the use of multiple tasks listed with the `after` keyword. Here is an example of how to use it and how it's interpreted:
165
+
166
+ ```mermaid-example
167
+ gantt
168
+ apple :a, 2017-07-20, 1w
169
+ banana :crit, b, 2017-07-23, 1d
170
+ cherry :active, c, after b a, 1d
171
+ kiwi :d, 2017-07-20, until b c
172
+ ```
173
+
174
+ ```mermaid
175
+ gantt
176
+ apple :a, 2017-07-20, 1w
177
+ banana :crit, b, 2017-07-23, 1d
178
+ cherry :active, c, after b a, 1d
179
+ kiwi :d, 2017-07-20, until b c
180
+ ```
181
+
182
+ ### Title
183
+
184
+ The `title` is an _optional_ string to be displayed at the top of the Gantt chart to describe the chart as a whole.
185
+
186
+ ### Excludes
187
+
188
+ The `excludes` is an _optional_ attribute that accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".
189
+ These date will be marked on the graph, and be excluded from the duration calculation of tasks. Meaning that if there are excluded dates during a task interval, the number of 'skipped' days will be added to the end of the task to ensure the duration is as specified in the code.
190
+
191
+ Multiple `excludes` lines are supported and their tokens are concatenated, so long exclusion lists can be split across grouped lines with comments:
192
+
193
+ ```
194
+ gantt
195
+ dateFormat DD-MM-YYYY
196
+ excludes weekends
197
+ %% week 7 is winter break
198
+ excludes 10-02-2025 11-02-2025 12-02-2025 13-02-2025 14-02-2025
199
+ %% workers holiday 1 maj
200
+ excludes 01-05-2025
201
+ ```
202
+
203
+ #### Weekend (v\11.0.0+)
204
+
205
+ When excluding weekends, it is possible to configure the weekends to be either Friday and Saturday or Saturday and Sunday. By default weekends are Saturday and Sunday.
206
+ To define the weekend start day, there is an _optional_ attribute `weekend` that can be added in a new line followed by either `friday` or `saturday`.
207
+
208
+ ```mermaid-example
209
+ gantt
210
+ title A Gantt Diagram Excluding Fri - Sat weekends
211
+ dateFormat YYYY-MM-DD
212
+ excludes weekends
213
+ weekend friday
214
+ section Section
215
+ A task :a1, 2024-01-01, 30d
216
+ Another task :after a1, 20d
217
+ ```
218
+
219
+ ```mermaid
220
+ gantt
221
+ title A Gantt Diagram Excluding Fri - Sat weekends
222
+ dateFormat YYYY-MM-DD
223
+ excludes weekends
224
+ weekend friday
225
+ section Section
226
+ A task :a1, 2024-01-01, 30d
227
+ Another task :after a1, 20d
228
+ ```
229
+
230
+ ### Section statements
231
+
232
+ You can divide the chart into various sections, for example to separate different parts of a project like development and documentation.
233
+
234
+ To do so, start a line with the `section` keyword and give it a name. (Note that unlike with the [title for the entire chart](#title), this name is _required_.
235
+
236
+ ### Milestones
237
+
238
+ You can add milestones to the diagrams. Milestones differ from tasks as they represent a single instant in time and are identified by the keyword `milestone`. Below is an example on how to use milestones. As you may notice, the exact location of the milestone is determined by the initial date for the milestone and the "duration" of the task this way: _initial date_+_duration_/2.
239
+
240
+ ```mermaid-example
241
+ gantt
242
+ dateFormat HH:mm
243
+ axisFormat %H:%M
244
+ Initial milestone : milestone, m1, 17:49, 2m
245
+ Task A : 10m
246
+ Task B : 5m
247
+ Final milestone : milestone, m2, 18:08, 4m
248
+ ```
249
+
250
+ ```mermaid
251
+ gantt
252
+ dateFormat HH:mm
253
+ axisFormat %H:%M
254
+ Initial milestone : milestone, m1, 17:49, 2m
255
+ Task A : 10m
256
+ Task B : 5m
257
+ Final milestone : milestone, m2, 18:08, 4m
258
+ ```
259
+
260
+ ### Vertical Markers
261
+
262
+ The `vert` keyword lets you add vertical lines to your Gantt chart, making it easy to highlight important dates like deadlines, events, or checkpoints. These markers extend across the entire chart and are positioned based on the date you provide. Unlike milestones, vertical markers don’t take up a row. They’re purely visual reference points that help break up the timeline and make important moments easier to spot.
263
+
264
+ ```mermaid-example
265
+ gantt
266
+ dateFormat HH:mm
267
+ axisFormat %H:%M
268
+ Initial vert : vert, v1, 17:30, 2m
269
+ Task A : 3m
270
+ Task B : 8m
271
+ Final vert : vert, v2, 17:58, 4m
272
+ ```
273
+
274
+ ```mermaid
275
+ gantt
276
+ dateFormat HH:mm
277
+ axisFormat %H:%M
278
+ Initial vert : vert, v1, 17:30, 2m
279
+ Task A : 3m
280
+ Task B : 8m
281
+ Final vert : vert, v2, 17:58, 4m
282
+ ```
283
+
284
+ ## Setting dates
285
+
286
+ `dateFormat` defines the format of the date **input** of your gantt elements. How these dates are represented in the rendered chart **output** are defined by `axisFormat`.
287
+
288
+ ### Input date format
289
+
290
+ The default input date format is `YYYY-MM-DD`. You can define your custom `dateFormat`.
291
+
292
+ ```markdown
293
+ dateFormat YYYY-MM-DD
294
+ ```
295
+
296
+ The following formatting options are supported:
297
+
298
+ | Input | Example | Description |
299
+ | ---------- | -------------- | ------------------------------------------------------ |
300
+ | `YYYY` | 2014 | 4 digit year |
301
+ | `YY` | 14 | 2 digit year |
302
+ | `Q` | 1..4 | Quarter of year. Sets month to first month in quarter. |
303
+ | `M MM` | 1..12 | Month number |
304
+ | `MMM MMMM` | January..Dec | Month name in locale set by `dayjs.locale()` |
305
+ | `D DD` | 1..31 | Day of month |
306
+ | `Do` | 1st..31st | Day of month with ordinal |
307
+ | `DDD DDDD` | 1..365 | Day of year |
308
+ | `X` | 1410715640.579 | Unix timestamp |
309
+ | `x` | 1410715640579 | Unix ms timestamp |
310
+ | `H HH` | 0..23 | 24 hour time |
311
+ | `h hh` | 1..12 | 12 hour time used with `a A`. |
312
+ | `a A` | am pm | Post or ante meridiem |
313
+ | `m mm` | 0..59 | Minutes |
314
+ | `s ss` | 0..59 | Seconds |
315
+ | `S` | 0..9 | Tenths of a second |
316
+ | `SS` | 0..99 | Hundreds of a second |
317
+ | `SSS` | 0..999 | Thousandths of a second |
318
+ | `Z ZZ` | +12:00 | Offset from UTC as +-HH:mm, +-HHmm, or Z |
319
+
320
+ More info in: <https://day.js.org/docs/en/parse/string-format/>
321
+
322
+ ### Output date format on the axis
323
+
324
+ The default output date format is `YYYY-MM-DD`. You can define your custom `axisFormat`, like `2020-Q1` for the first quarter of the year 2020.
325
+
326
+ ```markdown
327
+ axisFormat %Y-%m-%d
328
+ ```
329
+
330
+ The following formatting strings are supported:
331
+
332
+ | Format | Definition |
333
+ | ------ | ------------------------------------------------------------------------------------------ |
334
+ | %a | abbreviated weekday name |
335
+ | %A | full weekday name |
336
+ | %b | abbreviated month name |
337
+ | %B | full month name |
338
+ | %c | date and time, as "%a %b %e %H:%M:%S %Y" |
339
+ | %d | zero-padded day of the month as a decimal number \[01,31] |
340
+ | %e | space-padded day of the month as a decimal number \[ 1,31]; equivalent to %\_d |
341
+ | %H | hour (24-hour clock) as a decimal number \[00,23] |
342
+ | %I | hour (12-hour clock) as a decimal number \[01,12] |
343
+ | %j | day of the year as a decimal number \[001,366] |
344
+ | %m | month as a decimal number \[01,12] |
345
+ | %M | minute as a decimal number \[00,59] |
346
+ | %L | milliseconds as a decimal number \[000, 999] |
347
+ | %p | either AM or PM |
348
+ | %S | second as a decimal number \[00,61] |
349
+ | %U | week number of the year (Sunday as the first day of the week) as a decimal number \[00,53] |
350
+ | %w | weekday as a decimal number \[0(Sunday),6] |
351
+ | %W | week number of the year (Monday as the first day of the week) as a decimal number \[00,53] |
352
+ | %x | date, as "%m/%d/%Y" |
353
+ | %X | time, as "%H:%M:%S" |
354
+ | %y | year without century as a decimal number \[00,99] |
355
+ | %Y | year with century as a decimal number |
356
+ | %Z | time zone offset, such as "-0700" |
357
+ | %% | a literal "%" character |
358
+
359
+ More info in: <https://github.com/d3/d3-time-format/tree/v4.0.0#locale_format>
360
+
361
+ ### Axis ticks (v10.3.0+)
362
+
363
+ The default output ticks are auto. You can custom your `tickInterval`, like `1day` or `1week`.
364
+
365
+ ```markdown
366
+ tickInterval 1day
367
+ ```
368
+
369
+ The pattern is:
370
+
371
+ ```javascript
372
+ /^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/;
373
+ ```
374
+
375
+ More info in: <https://github.com/d3/d3-time#interval_every>
376
+
377
+ Week-based `tickInterval`s start the week on sunday by default. If you wish to specify another weekday on which the `tickInterval` should start, use the `weekday` option:
378
+
379
+ ```mermaid-example
380
+ gantt
381
+ tickInterval 1week
382
+ weekday monday
383
+ ```
384
+
385
+ ```mermaid
386
+ gantt
387
+ tickInterval 1week
388
+ weekday monday
389
+ ```
390
+
391
+ > **Warning**
392
+ > `millisecond` and `second` support was added in v10.3.0
393
+
394
+ ## Output in compact mode
395
+
396
+ The compact mode allows you to display multiple tasks in the same row. Compact mode can be enabled for a gantt chart by setting the display mode of the graph via preceding YAML settings.
397
+
398
+ ```mermaid-example
399
+ ---
400
+ displayMode: compact
401
+ ---
402
+ gantt
403
+ title A Gantt Diagram
404
+ dateFormat YYYY-MM-DD
405
+
406
+ section Section
407
+ A task :a1, 2014-01-01, 30d
408
+ Another task :a2, 2014-01-20, 25d
409
+ Another one :a3, 2014-02-10, 20d
410
+ ```
411
+
412
+ ```mermaid
413
+ ---
414
+ displayMode: compact
415
+ ---
416
+ gantt
417
+ title A Gantt Diagram
418
+ dateFormat YYYY-MM-DD
419
+
420
+ section Section
421
+ A task :a1, 2014-01-01, 30d
422
+ Another task :a2, 2014-01-20, 25d
423
+ Another one :a3, 2014-02-10, 20d
424
+ ```
425
+
426
+ ## Comments
427
+
428
+ Comments can be entered within a gantt chart, which will be ignored by the parser. Comments need to be on their own line and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any diagram syntax.
429
+
430
+ ```mermaid-example
431
+ gantt
432
+ title A Gantt Diagram
433
+ %% This is a comment
434
+ dateFormat YYYY-MM-DD
435
+ section Section
436
+ A task :a1, 2014-01-01, 30d
437
+ Another task :after a1, 20d
438
+ section Another
439
+ Task in Another :2014-01-12, 12d
440
+ another task :24d
441
+ ```
442
+
443
+ ```mermaid
444
+ gantt
445
+ title A Gantt Diagram
446
+ %% This is a comment
447
+ dateFormat YYYY-MM-DD
448
+ section Section
449
+ A task :a1, 2014-01-01, 30d
450
+ Another task :after a1, 20d
451
+ section Another
452
+ Task in Another :2014-01-12, 12d
453
+ another task :24d
454
+ ```
455
+
456
+ ## Styling
457
+
458
+ Styling of the Gantt diagram is done by defining a number of CSS classes. During rendering, these classes are extracted from the file located at src/diagrams/gantt/styles.js
459
+
460
+ ### Classes used
461
+
462
+ | Class | Description |
463
+ | --------------------- | ---------------------------------------------------------------------- |
464
+ | grid.tick | Styling for the Grid Lines |
465
+ | grid.path | Styling for the Grid's borders |
466
+ | .taskText | Task Text Styling |
467
+ | .taskTextOutsideRight | Styling for Task Text that exceeds the activity bar towards the right. |
468
+ | .taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. |
469
+ | todayMarker | Toggle and Styling for the "Today Marker" |
470
+
471
+ ### Sample stylesheet
472
+
473
+ ```css
474
+ .grid .tick {
475
+ stroke: lightgrey;
476
+ opacity: 0.3;
477
+ shape-rendering: crispEdges;
478
+ }
479
+ .grid path {
480
+ stroke-width: 0;
481
+ }
482
+
483
+ #tag {
484
+ color: white;
485
+ background: #fa283d;
486
+ width: 150px;
487
+ position: absolute;
488
+ display: none;
489
+ padding: 3px 6px;
490
+ margin-left: -80px;
491
+ font-size: 11px;
492
+ }
493
+
494
+ #tag:before {
495
+ border: solid transparent;
496
+ content: ' ';
497
+ height: 0;
498
+ left: 50%;
499
+ margin-left: -5px;
500
+ position: absolute;
501
+ width: 0;
502
+ border-width: 10px;
503
+ border-bottom-color: #fa283d;
504
+ top: -20px;
505
+ }
506
+ .taskText {
507
+ fill: white;
508
+ text-anchor: middle;
509
+ }
510
+ .taskTextOutsideRight {
511
+ fill: black;
512
+ text-anchor: start;
513
+ }
514
+ .taskTextOutsideLeft {
515
+ fill: black;
516
+ text-anchor: end;
517
+ }
518
+ ```
519
+
520
+ ## Today marker
521
+
522
+ You can style or hide the marker for the current date. To style it, add a value for the `todayMarker` key.
523
+
524
+ ```
525
+ todayMarker stroke-width:5px,stroke:#0f0,opacity:0.5
526
+ ```
527
+
528
+ To hide the marker, set `todayMarker` to `off`.
529
+
530
+ ```
531
+ todayMarker off
532
+ ```
533
+
534
+ ## Configuration
535
+
536
+ It is possible to adjust the margins for rendering the gantt diagram.
537
+
538
+ This is done by defining the `ganttConfig` part of the configuration object.
539
+ How to use the CLI is described in the [mermaidCLI](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/docs/config/mermaidCLI.md) page.
540
+
541
+ mermaid.ganttConfig can be set to a JSON string with config parameters or the corresponding object.
542
+
543
+ ```javascript
544
+ mermaid.ganttConfig = {
545
+ titleTopMargin: 25, // Margin top for the text over the diagram
546
+ barHeight: 20, // The height of the bars in the graph
547
+ barGap: 4, // The margin between the different activities in the gantt diagram
548
+ topPadding: 75, // Margin between title and gantt diagram and between axis and gantt diagram.
549
+ rightPadding: 75, // The space allocated for the section name to the right of the activities
550
+ leftPadding: 75, // The space allocated for the section name to the left of the activities
551
+ gridLineStartPadding: 10, // Vertical starting position of the grid lines
552
+ fontSize: 12, // Font size
553
+ sectionFontSize: 24, // Font size for sections
554
+ numberSectionStyles: 1, // The number of alternating section styles
555
+ axisFormat: '%d/%m', // Date/time format of the axis
556
+ tickInterval: '1week', // Axis ticks
557
+ topAxis: true, // When this flag is set, date labels will be added to the top of the chart
558
+ displayMode: 'compact', // Turns compact mode on
559
+ weekday: 'sunday', // On which day a week-based interval should start
560
+ };
561
+ ```
562
+
563
+ ### Possible configuration params:
564
+
565
+ | Param | Description | Default value |
566
+ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
567
+ | mirrorActor | Turns on/off the rendering of actors below the diagram as well as above it | false |
568
+ | bottomMarginAdj | Adjusts how far down the graph ended. Wide borders styles with css could generate unwanted clipping which is why this config param exists. | 1 |
569
+
570
+ ## Interaction
571
+
572
+ It is possible to bind a click event to a task. The click can lead to either a javascript callback or to a link which will be opened in the current browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`.
573
+
574
+ ```
575
+ click taskId call callback(arguments)
576
+ click taskId href URL
577
+ ```
578
+
579
+ - taskId is the id of the task
580
+ - callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified.
581
+
582
+ Beginner's tip—a full example using interactive links in an HTML context:
583
+
584
+ ```html
585
+ <body>
586
+ <pre class="mermaid">
587
+ gantt
588
+ dateFormat YYYY-MM-DD
589
+
590
+ section Clickable
591
+ Visit mermaidjs :active, cl1, 2014-01-07, 3d
592
+ Print arguments :cl2, after cl1, 3d
593
+ Print task :cl3, after cl2, 3d
594
+
595
+ click cl1 href "https://mermaidjs.github.io/"
596
+ click cl2 call printArguments("test1", "test2", test3)
597
+ click cl3 call printTask()
598
+ </pre>
599
+
600
+ <script>
601
+ const printArguments = function (arg1, arg2, arg3) {
602
+ alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3);
603
+ };
604
+ const printTask = function (taskId) {
605
+ alert('taskId: ' + taskId);
606
+ };
607
+ const config = {
608
+ startOnLoad: true,
609
+ securityLevel: 'loose',
610
+ };
611
+ mermaid.initialize(config);
612
+ </script>
613
+ </body>
614
+ ```
615
+
616
+ ## Examples
617
+
618
+ ### Bar chart (using gantt chart)
619
+
620
+ ```mermaid-example
621
+ gantt
622
+ title Git Issues - days since last update
623
+ dateFormat X
624
+ axisFormat %s
625
+ section Issue19062
626
+ 71 : 0, 71
627
+ section Issue19401
628
+ 36 : 0, 36
629
+ section Issue193
630
+ 34 : 0, 34
631
+ section Issue7441
632
+ 9 : 0, 9
633
+ section Issue1300
634
+ 5 : 0, 5
635
+ ```
636
+
637
+ ```mermaid
638
+ gantt
639
+ title Git Issues - days since last update
640
+ dateFormat X
641
+ axisFormat %s
642
+ section Issue19062
643
+ 71 : 0, 71
644
+ section Issue19401
645
+ 36 : 0, 36
646
+ section Issue193
647
+ 34 : 0, 34
648
+ section Issue7441
649
+ 9 : 0, 9
650
+ section Issue1300
651
+ 5 : 0, 5
652
+ ```
653
+
654
+ ### Timeline (with comments, CSS, config in frontmatter)
655
+
656
+ ```mermaid-example
657
+ ---
658
+ # Frontmatter config, YAML comments
659
+ title: Ignored if specified in chart
660
+ displayMode: compact #gantt specific setting but works at this level too
661
+ config:
662
+ # theme: forest
663
+ # themeCSS: " #item36 { fill: CadetBlue } "
664
+ themeCSS: " // YAML supports multiline strings using a newline markers: \n
665
+ #item36 { fill: CadetBlue } \n
666
+
667
+ // Custom marker workaround CSS from forum (below) \n
668
+ rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n
669
+ text[id^=workaround] { fill: red; y: 100%; font-size: 15px;}
670
+ "
671
+ gantt:
672
+ useWidth: 400
673
+ rightPadding: 0
674
+ topAxis: true #false
675
+ numberSectionStyles: 2
676
+ ---
677
+ gantt
678
+ title Timeline - Gantt Sampler
679
+ dateFormat YYYY
680
+ axisFormat %y
681
+ %% this next line doesn't recognise 'decade' or 'year', but will silently ignore
682
+ tickInterval 1decade
683
+
684
+ section Issue19062
685
+ 71 : item71, 1900, 1930
686
+ section Issue19401
687
+ 36 : item36, 1913, 1935
688
+ section Issue1300
689
+ 94 : item94, 1910, 1915
690
+ 5 : item5, 1920, 1925
691
+ 0 : milestone, item0, 1918, 1s
692
+ 9 : vert, 1906, 1s %% not yet official
693
+ 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250
694
+ ```
695
+
696
+ ```mermaid
697
+ ---
698
+ # Frontmatter config, YAML comments
699
+ title: Ignored if specified in chart
700
+ displayMode: compact #gantt specific setting but works at this level too
701
+ config:
702
+ # theme: forest
703
+ # themeCSS: " #item36 { fill: CadetBlue } "
704
+ themeCSS: " // YAML supports multiline strings using a newline markers: \n
705
+ #item36 { fill: CadetBlue } \n
706
+
707
+ // Custom marker workaround CSS from forum (below) \n
708
+ rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n
709
+ text[id^=workaround] { fill: red; y: 100%; font-size: 15px;}
710
+ "
711
+ gantt:
712
+ useWidth: 400
713
+ rightPadding: 0
714
+ topAxis: true #false
715
+ numberSectionStyles: 2
716
+ ---
717
+ gantt
718
+ title Timeline - Gantt Sampler
719
+ dateFormat YYYY
720
+ axisFormat %y
721
+ %% this next line doesn't recognise 'decade' or 'year', but will silently ignore
722
+ tickInterval 1decade
723
+
724
+ section Issue19062
725
+ 71 : item71, 1900, 1930
726
+ section Issue19401
727
+ 36 : item36, 1913, 1935
728
+ section Issue1300
729
+ 94 : item94, 1910, 1915
730
+ 5 : item5, 1920, 1925
731
+ 0 : milestone, item0, 1918, 1s
732
+ 9 : vert, 1906, 1s %% not yet official
733
+ 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250
734
+ ```
735
+
736
+ <!--- cspell:ignore isadded --->