minimal-vibe-coding-kit 0.5.0 → 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 (378) 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/.agents/skills/tutien/SKILL.md +36 -13
  59. package/.agents/skills/tutien/references/adaptive-response.md +68 -0
  60. package/.agents/skills/tutien/references/lore-sources.md +28 -0
  61. package/.agents/skills/tutien/references/privacy.md +13 -1
  62. package/.agents/skills/tutien/references/schema.md +32 -1
  63. package/.agents/skills/tutien/references/story-system.md +176 -0
  64. package/.agents/skills/tutien/references/vi-style-guide.md +89 -0
  65. package/.agents/skills/tutien/references/voice-and-mode.md +23 -8
  66. package/.agents/skills/tutien/scripts/catalog.mjs +17 -17
  67. package/.agents/skills/tutien/scripts/classify.mjs +64 -37
  68. package/.agents/skills/tutien/scripts/command.mjs +40 -21
  69. package/.agents/skills/tutien/scripts/project-profile.mjs +202 -0
  70. package/.agents/skills/tutien/scripts/render-report.mjs +128 -72
  71. package/.agents/skills/tutien/scripts/response-brief.mjs +103 -0
  72. package/.agents/skills/tutien/scripts/run-tutien.mjs +141 -63
  73. package/.agents/skills/tutien/scripts/story-ledger.mjs +241 -0
  74. package/.agents/skills/tutien/scripts/villains.mjs +14 -14
  75. package/.claude/skills/agentshield-security-review/SKILL.md +16 -8
  76. package/.claude/skills/agentshield-security-review/references/native-install.md +2 -2
  77. package/.claude/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  78. package/.claude/skills/mermaid/SKILL.md +141 -0
  79. package/.claude/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  80. package/.claude/skills/mermaid/references/architecture.md +433 -0
  81. package/.claude/skills/mermaid/references/block.md +752 -0
  82. package/.claude/skills/mermaid/references/c4.md +618 -0
  83. package/.claude/skills/mermaid/references/classDiagram.md +1191 -0
  84. package/.claude/skills/mermaid/references/coding-level-charts.md +27 -0
  85. package/.claude/skills/mermaid/references/config-configuration.md +71 -0
  86. package/.claude/skills/mermaid/references/config-directives.md +341 -0
  87. package/.claude/skills/mermaid/references/config-layouts.md +39 -0
  88. package/.claude/skills/mermaid/references/config-math.md +95 -0
  89. package/.claude/skills/mermaid/references/config-theming.md +245 -0
  90. package/.claude/skills/mermaid/references/config-tidy-tree.md +88 -0
  91. package/.claude/skills/mermaid/references/cynefin.md +278 -0
  92. package/.claude/skills/mermaid/references/debug-heatmap.md +68 -0
  93. package/.claude/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  94. package/.claude/skills/mermaid/references/eventmodeling.md +474 -0
  95. package/.claude/skills/mermaid/references/examples.md +300 -0
  96. package/.claude/skills/mermaid/references/flowchart.md +2166 -0
  97. package/.claude/skills/mermaid/references/gantt.md +736 -0
  98. package/.claude/skills/mermaid/references/gitgraph.md +2137 -0
  99. package/.claude/skills/mermaid/references/ishikawa.md +65 -0
  100. package/.claude/skills/mermaid/references/kanban.md +160 -0
  101. package/.claude/skills/mermaid/references/kit-examples.md +210 -0
  102. package/.claude/skills/mermaid/references/mindmap.md +334 -0
  103. package/.claude/skills/mermaid/references/packet.md +152 -0
  104. package/.claude/skills/mermaid/references/pie.md +111 -0
  105. package/.claude/skills/mermaid/references/preview.html +1143 -0
  106. package/.claude/skills/mermaid/references/quadrantChart.md +266 -0
  107. package/.claude/skills/mermaid/references/radar.md +268 -0
  108. package/.claude/skills/mermaid/references/railroad.md +455 -0
  109. package/.claude/skills/mermaid/references/requirementDiagram.md +494 -0
  110. package/.claude/skills/mermaid/references/sankey.md +414 -0
  111. package/.claude/skills/mermaid/references/sequenceDiagram.md +1206 -0
  112. package/.claude/skills/mermaid/references/stateDiagram.md +669 -0
  113. package/.claude/skills/mermaid/references/styling-preset.md +620 -0
  114. package/.claude/skills/mermaid/references/swimlanes.md +523 -0
  115. package/.claude/skills/mermaid/references/timeline.md +570 -0
  116. package/.claude/skills/mermaid/references/treeView.md +432 -0
  117. package/.claude/skills/mermaid/references/treemap.md +352 -0
  118. package/.claude/skills/mermaid/references/userJourney.md +41 -0
  119. package/.claude/skills/mermaid/references/venn.md +156 -0
  120. package/.claude/skills/mermaid/references/wardley.md +731 -0
  121. package/.claude/skills/mermaid/references/xyChart.md +392 -0
  122. package/.claude/skills/mermaid/references/zenuml.md +473 -0
  123. package/.claude/skills/sequential-thinking/SKILL.md +97 -69
  124. package/.claude/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  125. package/.claude/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  126. package/.claude/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  127. package/.claude/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  128. package/.claude/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  129. package/.claude/skills/sequential-thinking/references/output-schema.md +99 -458
  130. package/.claude/skills/sequential-thinking/references/parameters.md +73 -435
  131. package/.claude/skills/sequential-thinking/references/patterns.md +72 -639
  132. package/.claude/skills/tutien/SKILL.md +36 -13
  133. package/.claude/skills/tutien/references/adaptive-response.md +68 -0
  134. package/.claude/skills/tutien/references/lore-sources.md +28 -0
  135. package/.claude/skills/tutien/references/privacy.md +13 -1
  136. package/.claude/skills/tutien/references/schema.md +32 -1
  137. package/.claude/skills/tutien/references/story-system.md +176 -0
  138. package/.claude/skills/tutien/references/vi-style-guide.md +89 -0
  139. package/.claude/skills/tutien/references/voice-and-mode.md +23 -8
  140. package/.claude/skills/tutien/scripts/catalog.mjs +17 -17
  141. package/.claude/skills/tutien/scripts/classify.mjs +64 -37
  142. package/.claude/skills/tutien/scripts/command.mjs +40 -21
  143. package/.claude/skills/tutien/scripts/project-profile.mjs +202 -0
  144. package/.claude/skills/tutien/scripts/render-report.mjs +128 -72
  145. package/.claude/skills/tutien/scripts/response-brief.mjs +103 -0
  146. package/.claude/skills/tutien/scripts/run-tutien.mjs +141 -63
  147. package/.claude/skills/tutien/scripts/story-ledger.mjs +241 -0
  148. package/.claude/skills/tutien/scripts/villains.mjs +14 -14
  149. package/.codex-plugin/plugin.json +1 -1
  150. package/.cursor/skills/mermaid/SKILL.md +141 -0
  151. package/.cursor/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  152. package/.cursor/skills/mermaid/references/architecture.md +433 -0
  153. package/.cursor/skills/mermaid/references/block.md +752 -0
  154. package/.cursor/skills/mermaid/references/c4.md +618 -0
  155. package/.cursor/skills/mermaid/references/classDiagram.md +1191 -0
  156. package/.cursor/skills/mermaid/references/coding-level-charts.md +27 -0
  157. package/.cursor/skills/mermaid/references/config-configuration.md +71 -0
  158. package/.cursor/skills/mermaid/references/config-directives.md +341 -0
  159. package/.cursor/skills/mermaid/references/config-layouts.md +39 -0
  160. package/.cursor/skills/mermaid/references/config-math.md +95 -0
  161. package/.cursor/skills/mermaid/references/config-theming.md +245 -0
  162. package/.cursor/skills/mermaid/references/config-tidy-tree.md +88 -0
  163. package/.cursor/skills/mermaid/references/cynefin.md +278 -0
  164. package/.cursor/skills/mermaid/references/debug-heatmap.md +68 -0
  165. package/.cursor/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  166. package/.cursor/skills/mermaid/references/eventmodeling.md +474 -0
  167. package/.cursor/skills/mermaid/references/examples.md +300 -0
  168. package/.cursor/skills/mermaid/references/flowchart.md +2166 -0
  169. package/.cursor/skills/mermaid/references/gantt.md +736 -0
  170. package/.cursor/skills/mermaid/references/gitgraph.md +2137 -0
  171. package/.cursor/skills/mermaid/references/ishikawa.md +65 -0
  172. package/.cursor/skills/mermaid/references/kanban.md +160 -0
  173. package/.cursor/skills/mermaid/references/kit-examples.md +210 -0
  174. package/.cursor/skills/mermaid/references/mindmap.md +334 -0
  175. package/.cursor/skills/mermaid/references/packet.md +152 -0
  176. package/.cursor/skills/mermaid/references/pie.md +111 -0
  177. package/.cursor/skills/mermaid/references/preview.html +1143 -0
  178. package/.cursor/skills/mermaid/references/quadrantChart.md +266 -0
  179. package/.cursor/skills/mermaid/references/radar.md +268 -0
  180. package/.cursor/skills/mermaid/references/railroad.md +455 -0
  181. package/.cursor/skills/mermaid/references/requirementDiagram.md +494 -0
  182. package/.cursor/skills/mermaid/references/sankey.md +414 -0
  183. package/.cursor/skills/mermaid/references/sequenceDiagram.md +1206 -0
  184. package/.cursor/skills/mermaid/references/stateDiagram.md +669 -0
  185. package/.cursor/skills/mermaid/references/styling-preset.md +620 -0
  186. package/.cursor/skills/mermaid/references/swimlanes.md +523 -0
  187. package/.cursor/skills/mermaid/references/timeline.md +570 -0
  188. package/.cursor/skills/mermaid/references/treeView.md +432 -0
  189. package/.cursor/skills/mermaid/references/treemap.md +352 -0
  190. package/.cursor/skills/mermaid/references/userJourney.md +41 -0
  191. package/.cursor/skills/mermaid/references/venn.md +156 -0
  192. package/.cursor/skills/mermaid/references/wardley.md +731 -0
  193. package/.cursor/skills/mermaid/references/xyChart.md +392 -0
  194. package/.cursor/skills/mermaid/references/zenuml.md +473 -0
  195. package/.cursor/skills/sequential-thinking/SKILL.md +97 -69
  196. package/.cursor/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  197. package/.cursor/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  198. package/.cursor/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  199. package/.cursor/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  200. package/.cursor/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  201. package/.cursor/skills/sequential-thinking/references/output-schema.md +99 -458
  202. package/.cursor/skills/sequential-thinking/references/parameters.md +73 -435
  203. package/.cursor/skills/sequential-thinking/references/patterns.md +72 -639
  204. package/.cursor/skills/tutien/SKILL.md +36 -13
  205. package/.cursor/skills/tutien/references/adaptive-response.md +68 -0
  206. package/.cursor/skills/tutien/references/lore-sources.md +28 -0
  207. package/.cursor/skills/tutien/references/privacy.md +13 -1
  208. package/.cursor/skills/tutien/references/schema.md +32 -1
  209. package/.cursor/skills/tutien/references/story-system.md +176 -0
  210. package/.cursor/skills/tutien/references/vi-style-guide.md +89 -0
  211. package/.cursor/skills/tutien/references/voice-and-mode.md +23 -8
  212. package/.cursor/skills/tutien/scripts/catalog.mjs +17 -17
  213. package/.cursor/skills/tutien/scripts/classify.mjs +64 -37
  214. package/.cursor/skills/tutien/scripts/command.mjs +40 -21
  215. package/.cursor/skills/tutien/scripts/project-profile.mjs +202 -0
  216. package/.cursor/skills/tutien/scripts/render-report.mjs +128 -72
  217. package/.cursor/skills/tutien/scripts/response-brief.mjs +103 -0
  218. package/.cursor/skills/tutien/scripts/run-tutien.mjs +141 -63
  219. package/.cursor/skills/tutien/scripts/story-ledger.mjs +241 -0
  220. package/.cursor/skills/tutien/scripts/villains.mjs +14 -14
  221. package/.grok/skills/agentshield-security-review/SKILL.md +16 -8
  222. package/.grok/skills/agentshield-security-review/references/native-install.md +2 -2
  223. package/.grok/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  224. package/.grok/skills/mermaid/SKILL.md +141 -0
  225. package/.grok/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  226. package/.grok/skills/mermaid/references/architecture.md +433 -0
  227. package/.grok/skills/mermaid/references/block.md +752 -0
  228. package/.grok/skills/mermaid/references/c4.md +618 -0
  229. package/.grok/skills/mermaid/references/classDiagram.md +1191 -0
  230. package/.grok/skills/mermaid/references/coding-level-charts.md +27 -0
  231. package/.grok/skills/mermaid/references/config-configuration.md +71 -0
  232. package/.grok/skills/mermaid/references/config-directives.md +341 -0
  233. package/.grok/skills/mermaid/references/config-layouts.md +39 -0
  234. package/.grok/skills/mermaid/references/config-math.md +95 -0
  235. package/.grok/skills/mermaid/references/config-theming.md +245 -0
  236. package/.grok/skills/mermaid/references/config-tidy-tree.md +88 -0
  237. package/.grok/skills/mermaid/references/cynefin.md +278 -0
  238. package/.grok/skills/mermaid/references/debug-heatmap.md +68 -0
  239. package/.grok/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  240. package/.grok/skills/mermaid/references/eventmodeling.md +474 -0
  241. package/.grok/skills/mermaid/references/examples.md +300 -0
  242. package/.grok/skills/mermaid/references/flowchart.md +2166 -0
  243. package/.grok/skills/mermaid/references/gantt.md +736 -0
  244. package/.grok/skills/mermaid/references/gitgraph.md +2137 -0
  245. package/.grok/skills/mermaid/references/ishikawa.md +65 -0
  246. package/.grok/skills/mermaid/references/kanban.md +160 -0
  247. package/.grok/skills/mermaid/references/kit-examples.md +210 -0
  248. package/.grok/skills/mermaid/references/mindmap.md +334 -0
  249. package/.grok/skills/mermaid/references/packet.md +152 -0
  250. package/.grok/skills/mermaid/references/pie.md +111 -0
  251. package/.grok/skills/mermaid/references/preview.html +1143 -0
  252. package/.grok/skills/mermaid/references/quadrantChart.md +266 -0
  253. package/.grok/skills/mermaid/references/radar.md +268 -0
  254. package/.grok/skills/mermaid/references/railroad.md +455 -0
  255. package/.grok/skills/mermaid/references/requirementDiagram.md +494 -0
  256. package/.grok/skills/mermaid/references/sankey.md +414 -0
  257. package/.grok/skills/mermaid/references/sequenceDiagram.md +1206 -0
  258. package/.grok/skills/mermaid/references/stateDiagram.md +669 -0
  259. package/.grok/skills/mermaid/references/styling-preset.md +620 -0
  260. package/.grok/skills/mermaid/references/swimlanes.md +523 -0
  261. package/.grok/skills/mermaid/references/timeline.md +570 -0
  262. package/.grok/skills/mermaid/references/treeView.md +432 -0
  263. package/.grok/skills/mermaid/references/treemap.md +352 -0
  264. package/.grok/skills/mermaid/references/userJourney.md +41 -0
  265. package/.grok/skills/mermaid/references/venn.md +156 -0
  266. package/.grok/skills/mermaid/references/wardley.md +731 -0
  267. package/.grok/skills/mermaid/references/xyChart.md +392 -0
  268. package/.grok/skills/mermaid/references/zenuml.md +473 -0
  269. package/.grok/skills/sequential-thinking/SKILL.md +97 -69
  270. package/.grok/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  271. package/.grok/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  272. package/.grok/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  273. package/.grok/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  274. package/.grok/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  275. package/.grok/skills/sequential-thinking/references/output-schema.md +99 -458
  276. package/.grok/skills/sequential-thinking/references/parameters.md +73 -435
  277. package/.grok/skills/sequential-thinking/references/patterns.md +72 -639
  278. package/.grok/skills/tutien/SKILL.md +36 -13
  279. package/.grok/skills/tutien/references/adaptive-response.md +68 -0
  280. package/.grok/skills/tutien/references/lore-sources.md +28 -0
  281. package/.grok/skills/tutien/references/privacy.md +13 -1
  282. package/.grok/skills/tutien/references/schema.md +32 -1
  283. package/.grok/skills/tutien/references/story-system.md +176 -0
  284. package/.grok/skills/tutien/references/vi-style-guide.md +89 -0
  285. package/.grok/skills/tutien/references/voice-and-mode.md +23 -8
  286. package/.grok/skills/tutien/scripts/catalog.mjs +17 -17
  287. package/.grok/skills/tutien/scripts/classify.mjs +64 -37
  288. package/.grok/skills/tutien/scripts/command.mjs +40 -21
  289. package/.grok/skills/tutien/scripts/project-profile.mjs +202 -0
  290. package/.grok/skills/tutien/scripts/render-report.mjs +128 -72
  291. package/.grok/skills/tutien/scripts/response-brief.mjs +103 -0
  292. package/.grok/skills/tutien/scripts/run-tutien.mjs +141 -63
  293. package/.grok/skills/tutien/scripts/story-ledger.mjs +241 -0
  294. package/.grok/skills/tutien/scripts/villains.mjs +14 -14
  295. package/.vibekit/docs/INSTALL.md +2 -1
  296. package/.vibekit/docs/SECURITY_MODEL.md +4 -1
  297. package/.vibekit/scripts/init-backbone.mjs +1 -1
  298. package/.vibekit/scripts/validate-kit.mjs +179 -3
  299. package/.vibekit/skills/agentshield-security-review/SKILL.md +16 -8
  300. package/.vibekit/skills/agentshield-security-review/references/native-install.md +2 -2
  301. package/.vibekit/skills/agentshield-security-review/scripts/agentshield_repo_probe.py +19 -1
  302. package/.vibekit/skills/mermaid/SKILL.md +141 -0
  303. package/.vibekit/skills/mermaid/UPSTREAM-NOTICE.md +52 -0
  304. package/.vibekit/skills/mermaid/references/architecture.md +433 -0
  305. package/.vibekit/skills/mermaid/references/block.md +752 -0
  306. package/.vibekit/skills/mermaid/references/c4.md +618 -0
  307. package/.vibekit/skills/mermaid/references/classDiagram.md +1191 -0
  308. package/.vibekit/skills/mermaid/references/coding-level-charts.md +27 -0
  309. package/.vibekit/skills/mermaid/references/config-configuration.md +71 -0
  310. package/.vibekit/skills/mermaid/references/config-directives.md +341 -0
  311. package/.vibekit/skills/mermaid/references/config-layouts.md +39 -0
  312. package/.vibekit/skills/mermaid/references/config-math.md +95 -0
  313. package/.vibekit/skills/mermaid/references/config-theming.md +245 -0
  314. package/.vibekit/skills/mermaid/references/config-tidy-tree.md +88 -0
  315. package/.vibekit/skills/mermaid/references/cynefin.md +278 -0
  316. package/.vibekit/skills/mermaid/references/debug-heatmap.md +68 -0
  317. package/.vibekit/skills/mermaid/references/entityRelationshipDiagram.md +902 -0
  318. package/.vibekit/skills/mermaid/references/eventmodeling.md +474 -0
  319. package/.vibekit/skills/mermaid/references/examples.md +300 -0
  320. package/.vibekit/skills/mermaid/references/flowchart.md +2166 -0
  321. package/.vibekit/skills/mermaid/references/gantt.md +736 -0
  322. package/.vibekit/skills/mermaid/references/gitgraph.md +2137 -0
  323. package/.vibekit/skills/mermaid/references/ishikawa.md +65 -0
  324. package/.vibekit/skills/mermaid/references/kanban.md +160 -0
  325. package/.vibekit/skills/mermaid/references/kit-examples.md +210 -0
  326. package/.vibekit/skills/mermaid/references/mindmap.md +334 -0
  327. package/.vibekit/skills/mermaid/references/packet.md +152 -0
  328. package/.vibekit/skills/mermaid/references/pie.md +111 -0
  329. package/.vibekit/skills/mermaid/references/preview.html +1143 -0
  330. package/.vibekit/skills/mermaid/references/quadrantChart.md +266 -0
  331. package/.vibekit/skills/mermaid/references/radar.md +268 -0
  332. package/.vibekit/skills/mermaid/references/railroad.md +455 -0
  333. package/.vibekit/skills/mermaid/references/requirementDiagram.md +494 -0
  334. package/.vibekit/skills/mermaid/references/sankey.md +414 -0
  335. package/.vibekit/skills/mermaid/references/sequenceDiagram.md +1206 -0
  336. package/.vibekit/skills/mermaid/references/stateDiagram.md +669 -0
  337. package/.vibekit/skills/mermaid/references/styling-preset.md +620 -0
  338. package/.vibekit/skills/mermaid/references/swimlanes.md +523 -0
  339. package/.vibekit/skills/mermaid/references/timeline.md +570 -0
  340. package/.vibekit/skills/mermaid/references/treeView.md +432 -0
  341. package/.vibekit/skills/mermaid/references/treemap.md +352 -0
  342. package/.vibekit/skills/mermaid/references/userJourney.md +41 -0
  343. package/.vibekit/skills/mermaid/references/venn.md +156 -0
  344. package/.vibekit/skills/mermaid/references/wardley.md +731 -0
  345. package/.vibekit/skills/mermaid/references/xyChart.md +392 -0
  346. package/.vibekit/skills/mermaid/references/zenuml.md +473 -0
  347. package/.vibekit/skills/sequential-thinking/SKILL.md +97 -69
  348. package/.vibekit/skills/sequential-thinking/examples/adaptive-depth.md +15 -536
  349. package/.vibekit/skills/sequential-thinking/examples/branching-exploration.md +18 -468
  350. package/.vibekit/skills/sequential-thinking/examples/linear-reasoning.md +22 -203
  351. package/.vibekit/skills/sequential-thinking/examples/revision-pattern.md +17 -298
  352. package/.vibekit/skills/sequential-thinking/references/advanced-techniques.md +98 -0
  353. package/.vibekit/skills/sequential-thinking/references/output-schema.md +99 -458
  354. package/.vibekit/skills/sequential-thinking/references/parameters.md +73 -435
  355. package/.vibekit/skills/sequential-thinking/references/patterns.md +72 -639
  356. package/.vibekit/skills/skills-manifest.json +2 -1
  357. package/.vibekit/skills/tutien/SKILL.md +36 -13
  358. package/.vibekit/skills/tutien/references/adaptive-response.md +68 -0
  359. package/.vibekit/skills/tutien/references/lore-sources.md +28 -0
  360. package/.vibekit/skills/tutien/references/privacy.md +13 -1
  361. package/.vibekit/skills/tutien/references/schema.md +32 -1
  362. package/.vibekit/skills/tutien/references/story-system.md +176 -0
  363. package/.vibekit/skills/tutien/references/vi-style-guide.md +89 -0
  364. package/.vibekit/skills/tutien/references/voice-and-mode.md +23 -8
  365. package/.vibekit/skills/tutien/scripts/catalog.mjs +17 -17
  366. package/.vibekit/skills/tutien/scripts/classify.mjs +64 -37
  367. package/.vibekit/skills/tutien/scripts/command.mjs +40 -21
  368. package/.vibekit/skills/tutien/scripts/project-profile.mjs +202 -0
  369. package/.vibekit/skills/tutien/scripts/render-report.mjs +128 -72
  370. package/.vibekit/skills/tutien/scripts/response-brief.mjs +103 -0
  371. package/.vibekit/skills/tutien/scripts/run-tutien.mjs +141 -63
  372. package/.vibekit/skills/tutien/scripts/story-ledger.mjs +241 -0
  373. package/.vibekit/skills/tutien/scripts/villains.mjs +14 -14
  374. package/CHANGELOG.md +47 -1
  375. package/README.md +273 -15
  376. package/docs/README.vi.md +290 -32
  377. package/docs/README.zh-CN.md +273 -15
  378. package/package.json +4 -2
@@ -0,0 +1,27 @@
1
+ # Coding-Level Chart Adaptation
2
+
3
+ Maintained by Minimal Vibe Coding Kit. The kit's `/coding-level` skill sets an explanation register from 0 (ELI5) to 5 (God). Diagrams must match that register the same way prose does: a beginner needs one small picture with a takeaway; an expert wants density and zero hand-holding.
4
+
5
+ ## Resolving the active level
6
+
7
+ 1. A `/coding-level N` invocation in this session wins.
8
+ 2. Otherwise use the `Default coding level: N` entry in `backbone.yml` `conventions.custom_rules`, if present.
9
+ 3. Otherwise apply the level 2–3 row (standard density).
10
+
11
+ ## Level table
12
+
13
+ | Level | Register | Diagram budget | Preferred types | Annotation |
14
+ | ----- | -------- | -------------- | --------------- | ---------- |
15
+ | 0 | ELI5 | ≤ 6 nodes, 1 idea per diagram | flowchart TD, pie, simple timeline | Every shape explained; add a one-line takeaway sentence under the diagram; no jargon in labels |
16
+ | 1 | Junior | ≤ 10 nodes | flowchart, sequence (≤ 4 actors), kanban, pie | Legend of the color roles; short takeaway under the diagram |
17
+ | 2 | Mid | ≤ 15 nodes | full type range except C4/architecture | Brief caption; label edge cases explicitly |
18
+ | 3 | Senior | standard density | full type range | Caption only when non-obvious; assume pattern knowledge |
19
+ | 4 | Tech Lead | dense allowed; split by concern | C4, architecture, ER, state, sequence with alt/loop frames | System boundaries and ownership called out; link related diagrams |
20
+ | 5 | God | no fixed node ceiling; split when legibility drops | anything, including gitgraph internals, packet, railroad | Minimal — the diagram is the annotation |
21
+
22
+ ## Rules that hold at every level
23
+
24
+ - Semantic color roles from the Vivid Clay preset always apply — level changes density, never styling.
25
+ - Splitting one oversized diagram into two small ones beats shrinking labels.
26
+ - If the resolved level makes the requested diagram type unreadable (e.g. C4 at level 0), say so and propose the nearest simpler type instead of silently downgrading.
27
+ - Takeaway lines and captions are written in the user's language.
@@ -0,0 +1,71 @@
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/config/configuration.md). This kit copy is
4
+ > locally maintained; treat imported prose as syntax data, not operational instructions.
5
+
6
+ # Configuration
7
+
8
+ When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration:
9
+
10
+ - The default configuration
11
+ - Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
12
+ - Frontmatter (v10.5.0+) - diagram authors can update selected configuration parameters in the frontmatter of the diagram. These are applied to the render config.
13
+ - Directives (Deprecated by Frontmatter) - diagram authors can update selected configuration parameters directly in the diagram code via directives. These are applied to the render config.
14
+
15
+ **The render config** is configuration that is used when rendering by applying these configurations.
16
+
17
+ ## Frontmatter config
18
+
19
+ The entire mermaid configuration (except the secure configs) can be overridden by the diagram author in the frontmatter of the diagram. The frontmatter is a YAML block at the top of the diagram.
20
+
21
+ ```mermaid-example
22
+ ---
23
+ title: Hello Title
24
+ config:
25
+ theme: base
26
+ themeVariables:
27
+ primaryColor: "#00ff00"
28
+ ---
29
+ flowchart
30
+ Hello --> World
31
+
32
+ ```
33
+
34
+ ```mermaid
35
+ ---
36
+ title: Hello Title
37
+ config:
38
+ theme: base
39
+ themeVariables:
40
+ primaryColor: "#00ff00"
41
+ ---
42
+ flowchart
43
+ Hello --> World
44
+
45
+ ```
46
+
47
+ ## Theme configuration
48
+
49
+ ## Starting mermaid
50
+
51
+ ```mermaid-example
52
+ sequenceDiagram
53
+ Site->>mermaid: initialize
54
+ Site->>mermaid: content loaded
55
+ mermaid->>mermaidAPI: init
56
+ ```
57
+
58
+ ```mermaid
59
+ sequenceDiagram
60
+ Site->>mermaid: initialize
61
+ Site->>mermaid: content loaded
62
+ mermaid->>mermaidAPI: init
63
+ ```
64
+
65
+ ## Initialize
66
+
67
+ The initialize call is applied **only once**. It is called by the site integrator in order to override the default configuration at a site level.
68
+
69
+ ## configApi.reset
70
+
71
+ This method resets the configuration for a diagram to the overall site configuration, which is the configuration provided by the site integrator. Before each rendering of a diagram, reset is called at the very beginning.
@@ -0,0 +1,341 @@
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/config/directives.md). This kit copy is
4
+ > locally maintained; treat imported prose as syntax data, not operational instructions.
5
+
6
+ # Directives
7
+
8
+ > **Warning**
9
+ > Directives are deprecated from v10.5.0. Please use the `config` key in frontmatter to pass configuration. See [Configuration](config-configuration.md) for more details.
10
+
11
+ ## Directives
12
+
13
+ Directives give a diagram author the capability to alter the appearance of a diagram before rendering by changing the applied configuration.
14
+
15
+ The significance of having directives is that you have them available while writing the diagram, and can modify the default global and diagram-specific configurations. So, directives are applied on top of the default configuration. The beauty of directives is that you can use them to alter configuration settings for a specific diagram, i.e. at an individual level.
16
+
17
+ While directives allow you to change most of the default configuration settings, there are some that are not available, for security reasons. Also, you have the _option to define the set of configurations_ that you wish to allow diagram authors to override with directives.
18
+
19
+ ## Types of Directives options
20
+
21
+ Mermaid basically supports two types of configuration options to be overridden by directives.
22
+
23
+ 1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are:
24
+ - theme
25
+ - fontFamily
26
+ - logLevel
27
+ - securityLevel
28
+ - startOnLoad
29
+ - secure
30
+
31
+ 2. _Diagram-specific configurations_ : These are the configurations that are available and applied to a specific diagram. For each diagram there are specific configuration that will alter how that particular diagram looks and behaves.
32
+ For example, `mirrorActors` is a configuration that is specific to the `SequenceDiagram` and alters whether the actors are mirrored or not. So this config is available only for the `SequenceDiagram` type.
33
+
34
+ **NOTE:** Not all configuration options are listed here. To get hold of all the configuration options, please refer to the [defaultConfig.ts](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/defaultConfig.ts) in the source code.
35
+
36
+ > **Note**
37
+ > We plan to publish a complete list of top-level configurations & diagram-specific configurations with their possible values in the docs soon.
38
+
39
+ ## Declaring directives
40
+
41
+ Now that we have defined the types of configurations that are available, we can learn how to declare directives.
42
+ A directive always starts and ends with `%%` signs with directive text in between, like `%% {directive_text} %%`.
43
+
44
+ Here the structure of a directive text is like a nested key-value pair map or a JSON object with root being _init_. Where all the general configurations are defined in the top level, and all the diagram specific configurations are defined one level deeper with diagram type as key/root for that section.
45
+
46
+ The following code snippet shows the structure of a directive:
47
+
48
+ ```
49
+ %%{
50
+ init: {
51
+ "theme": "dark",
52
+ "fontFamily": "monospace",
53
+ "logLevel": "info",
54
+ "htmlLabels": true,
55
+ "flowchart": {
56
+ "curve": "linear"
57
+ },
58
+ "sequence": {
59
+ "mirrorActors": true
60
+ }
61
+ }
62
+ }%%
63
+ ```
64
+
65
+ You can also define the directives in a single line, like this:
66
+
67
+ ```
68
+ %%{init: { **insert configuration options here** } }%%
69
+ ```
70
+
71
+ For example, the following code snippet:
72
+
73
+ ```
74
+ %%{init: { "sequence": { "mirrorActors":false }}}%%
75
+ ```
76
+
77
+ **Notes:**
78
+ The JSON object that is passed as {**argument**} must be valid key value pairs and encased in quotation marks or it will be ignored.
79
+ Valid Key Value pairs can be found in config.
80
+
81
+ Example with a simple graph:
82
+
83
+ ```mermaid-example
84
+ %%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%%
85
+ graph LR
86
+ A-->B
87
+ ```
88
+
89
+ ```mermaid
90
+ %%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%%
91
+ graph LR
92
+ A-->B
93
+ ```
94
+
95
+ Here the directive declaration will set the `logLevel` to `debug` and the `theme` to `dark` for a rendered mermaid diagram, changing the appearance of the diagram itself.
96
+
97
+ Note: You can use 'init' or 'initialize' as both are acceptable as init directives. Also note that `%%init%%` and `%%initialize%%` directives will be grouped together after they are parsed.
98
+
99
+ ```mermaid-example
100
+ %%{init: { 'logLevel': 'debug', 'theme': 'forest' } }%%
101
+ %%{initialize: { 'logLevel': 'fatal', "theme":'dark', 'startOnLoad': true } }%%
102
+ ...
103
+ ```
104
+
105
+ ```mermaid
106
+ %%{init: { 'logLevel': 'debug', 'theme': 'forest' } }%%
107
+ %%{initialize: { 'logLevel': 'fatal', "theme":'dark', 'startOnLoad': true } }%%
108
+ ...
109
+ ```
110
+
111
+ For example, parsing the above generates a single `%%init%%` JSON object below, combining the two directives and carrying over the last value given for `loglevel`:
112
+
113
+ ```json
114
+ {
115
+ "logLevel": "fatal",
116
+ "theme": "dark",
117
+ "startOnLoad": true
118
+ }
119
+ ```
120
+
121
+ This will then be sent to `mermaid.initialize(...)` for rendering.
122
+
123
+ ## Directive Examples
124
+
125
+ Now that the concept of directives has been explained, let us see some more examples of directive usage:
126
+
127
+ ### Changing theme via directive
128
+
129
+ The following code snippet changes `theme` to `forest`:
130
+
131
+ `%%{init: { "theme": "forest" } }%%`
132
+
133
+ Possible theme values are: `default`, `base`, `dark`, `forest` and `neutral`.
134
+ Default Value is `default`.
135
+
136
+ Example:
137
+
138
+ ```mermaid-example
139
+ %%{init: { "theme": "forest" } }%%
140
+ graph TD
141
+ A(Forest) --> B[/Another/]
142
+ A --> C[End]
143
+ subgraph section
144
+ B
145
+ C
146
+ end
147
+
148
+ ```
149
+
150
+ ```mermaid
151
+ %%{init: { "theme": "forest" } }%%
152
+ graph TD
153
+ A(Forest) --> B[/Another/]
154
+ A --> C[End]
155
+ subgraph section
156
+ B
157
+ C
158
+ end
159
+
160
+ ```
161
+
162
+ ### Changing fontFamily via directive
163
+
164
+ The following code snippet changes fontFamily to Trebuchet MS, Verdana, Arial, Sans-Serif:
165
+
166
+ `%%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%`
167
+
168
+ Example:
169
+
170
+ ```mermaid-example
171
+ %%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%
172
+ graph TD
173
+ A(Forest) --> B[/Another/]
174
+ A --> C[End]
175
+ subgraph section
176
+ B
177
+ C
178
+ end
179
+
180
+ ```
181
+
182
+ ```mermaid
183
+ %%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%
184
+ graph TD
185
+ A(Forest) --> B[/Another/]
186
+ A --> C[End]
187
+ subgraph section
188
+ B
189
+ C
190
+ end
191
+
192
+ ```
193
+
194
+ ### Changing logLevel via directive
195
+
196
+ The following code snippet changes `logLevel` to `2`:
197
+
198
+ `%%{init: { "logLevel": 2 } }%%`
199
+
200
+ Possible `logLevel` values are:
201
+
202
+ - `1` for _debug_,
203
+ - `2` for _info_
204
+ - `3` for _warn_
205
+ - `4` for _error_
206
+ - `5` for _only fatal errors_
207
+
208
+ Default Value is `5`.
209
+
210
+ Example:
211
+
212
+ ```mermaid-example
213
+ %%{init: { "logLevel": 2 } }%%
214
+ graph TD
215
+ A(Forest) --> B[/Another/]
216
+ A --> C[End]
217
+ subgraph section
218
+ B
219
+ C
220
+ end
221
+ ```
222
+
223
+ ```mermaid
224
+ %%{init: { "logLevel": 2 } }%%
225
+ graph TD
226
+ A(Forest) --> B[/Another/]
227
+ A --> C[End]
228
+ subgraph section
229
+ B
230
+ C
231
+ end
232
+ ```
233
+
234
+ ### Changing flowchart config via directive
235
+
236
+ Some common flowchart configurations are:
237
+
238
+ - ~~_htmlLabels_~~: Deprecated, [prefer setting this at the root level](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/schemas/config.schema.yaml#L164-L170).
239
+ - _curve_: linear/curve
240
+ - _diagramPadding_: number
241
+ - _useMaxWidth_: number
242
+
243
+ For a complete list of flowchart configurations, see [defaultConfig.ts](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/defaultConfig.ts) in the source code.
244
+ _Soon we plan to publish a complete list of all diagram-specific configurations updated in the docs._
245
+
246
+ The following code snippet changes flowchart config:
247
+
248
+ ```
249
+ %%{init: { "htmlLabels": true, "flowchart": { "curve": "linear" } } }%%
250
+ ```
251
+
252
+ Here we are overriding only the flowchart config, and not the general config, setting `htmlLabels` to `true` and `curve` to `linear`.
253
+
254
+ > **Warning**
255
+ > **Deprecated:** `flowchart.htmlLabels` has been deprecated from (v11.12.3+). Use the global `htmlLabels` configuration instead. For example, instead of `"flowchart": { "htmlLabels": true }`, use `"htmlLabels": true` at the top level.
256
+
257
+ ```mermaid-example
258
+ %%{init: { "flowchart": { "htmlLabels": true, "curve": "linear" } } }%%
259
+ graph TD
260
+ A(Forest) --> B[/Another/]
261
+ A --> C[End]
262
+ subgraph section
263
+ B
264
+ C
265
+ end
266
+ ```
267
+
268
+ ```mermaid
269
+ %%{init: { "flowchart": { "htmlLabels": true, "curve": "linear" } } }%%
270
+ graph TD
271
+ A(Forest) --> B[/Another/]
272
+ A --> C[End]
273
+ subgraph section
274
+ B
275
+ C
276
+ end
277
+ ```
278
+
279
+ ### Changing Sequence diagram config via directive
280
+
281
+ Some common sequence diagram configurations are:
282
+
283
+ - _width_: number
284
+ - _height_: number
285
+ - _messageAlign_: left, center, right
286
+ - _mirrorActors_: boolean
287
+ - _useMaxWidth_: boolean
288
+ - _rightAngles_: boolean
289
+ - _showSequenceNumbers_: boolean
290
+ - _wrap_: boolean
291
+
292
+ For a complete list of sequence diagram configurations, see [defaultConfig.ts](https://github.com/mermaid-js/mermaid/blob/mermaid%4011.16.0/packages/mermaid/src/defaultConfig.ts) in the source code.
293
+ _Soon we plan to publish a complete list of all diagram-specific configurations updated in the docs._
294
+
295
+ So, `wrap` by default has a value of `false` for sequence diagrams.
296
+
297
+ Let us see an example:
298
+
299
+ ```mermaid-example
300
+ sequenceDiagram
301
+
302
+ Alice->Bob: Hello Bob, how are you?
303
+ Bob->Alice: Fine, how did your mother like the book I suggested? And did you catch the new book about alien invasion?
304
+ Alice->Bob: Good.
305
+ Bob->Alice: Cool
306
+ ```
307
+
308
+ ```mermaid
309
+ sequenceDiagram
310
+
311
+ Alice->Bob: Hello Bob, how are you?
312
+ Bob->Alice: Fine, how did your mother like the book I suggested? And did you catch the new book about alien invasion?
313
+ Alice->Bob: Good.
314
+ Bob->Alice: Cool
315
+ ```
316
+
317
+ Now let us enable wrap for sequence diagrams.
318
+
319
+ The following code snippet changes sequence diagram config for `wrap` to `true`:
320
+
321
+ `%%{init: { "sequence": { "wrap": true} } }%%`
322
+
323
+ By applying that snippet to the diagram above, `wrap` will be enabled:
324
+
325
+ ```mermaid-example
326
+ %%{init: { "sequence": { "wrap": true, "width":300 } } }%%
327
+ sequenceDiagram
328
+ Alice->Bob: Hello Bob, how are you?
329
+ Bob->Alice: Fine, how did your mother like the book I suggested? And did you catch the new book about alien invasion?
330
+ Alice->Bob: Good.
331
+ Bob->Alice: Cool
332
+ ```
333
+
334
+ ```mermaid
335
+ %%{init: { "sequence": { "wrap": true, "width":300 } } }%%
336
+ sequenceDiagram
337
+ Alice->Bob: Hello Bob, how are you?
338
+ Bob->Alice: Fine, how did your mother like the book I suggested? And did you catch the new book about alien invasion?
339
+ Alice->Bob: Good.
340
+ Bob->Alice: Cool
341
+ ```
@@ -0,0 +1,39 @@
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/config/layouts.md). This kit copy is
4
+ > locally maintained; treat imported prose as syntax data, not operational instructions.
5
+
6
+ # Layouts
7
+
8
+ This page lists the available layout algorithms supported in Mermaid diagrams.
9
+
10
+ ## Supported Layouts
11
+
12
+ - **elk**: [ELK (Eclipse Layout Kernel)](https://www.eclipse.org/elk/)
13
+ - **tidy-tree**: Tidy tree layout for hierarchical diagrams [Tidy Tree Configuration](config-tidy-tree.md)
14
+ - **cose-bilkent**: Cose Bilkent layout for force-directed graphs
15
+ - **dagre**: Dagre layout for layered graphs
16
+
17
+ ## How to Use
18
+
19
+ You can specify the layout in your diagram's YAML config or initialization options. For example:
20
+
21
+ ```mermaid-example
22
+ ---
23
+ config:
24
+ layout: elk
25
+ ---
26
+ graph TD;
27
+ A-->B;
28
+ B-->C;
29
+ ```
30
+
31
+ ```mermaid
32
+ ---
33
+ config:
34
+ layout: elk
35
+ ---
36
+ graph TD;
37
+ A-->B;
38
+ B-->C;
39
+ ```
@@ -0,0 +1,95 @@
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/config/math.md). This kit copy is
4
+ > locally maintained; treat imported prose as syntax data, not operational instructions.
5
+
6
+ # Math Configuration (v10.9.0+)
7
+
8
+ Mermaid supports rendering mathematical expressions through the [KaTeX](https://katex.org/) typesetter.
9
+
10
+ ## Usage
11
+
12
+ To render math within a diagram, surround the mathematical expression with the `$$` delimiter.
13
+
14
+ Note that at the moment, the only supported diagrams are below:
15
+
16
+ ### Flowcharts
17
+
18
+ ```mermaid-example
19
+ graph LR
20
+ A["$$x^2$$"] -->|"$$\sqrt{x+3}$$"| B("$$\frac{1}{2}$$")
21
+ A -->|"$$\overbrace{a+b+c}^{\text{note}}$$"| C("$$\pi r^2$$")
22
+ B --> D("$$x = \begin{cases} a &\text{if } b \\ c &\text{if } d \end{cases}$$")
23
+ C --> E("$$x(t)=c_1\begin{bmatrix}-\cos{t}+\sin{t}\\ 2\cos{t} \end{bmatrix}e^{2t}$$")
24
+ ```
25
+
26
+ ```mermaid
27
+ graph LR
28
+ A["$$x^2$$"] -->|"$$\sqrt{x+3}$$"| B("$$\frac{1}{2}$$")
29
+ A -->|"$$\overbrace{a+b+c}^{\text{note}}$$"| C("$$\pi r^2$$")
30
+ B --> D("$$x = \begin{cases} a &\text{if } b \\ c &\text{if } d \end{cases}$$")
31
+ C --> E("$$x(t)=c_1\begin{bmatrix}-\cos{t}+\sin{t}\\ 2\cos{t} \end{bmatrix}e^{2t}$$")
32
+ ```
33
+
34
+ ### Sequence
35
+
36
+ ```mermaid-example
37
+ sequenceDiagram
38
+ autonumber
39
+ participant 1 as $$\alpha$$
40
+ participant 2 as $$\beta$$
41
+ 1->>2: Solve: $$\sqrt{2+2}$$
42
+ 2-->>1: Answer: $$2$$
43
+ Note right of 2: $$\sqrt{2+2}=\sqrt{4}=2$$
44
+ ```
45
+
46
+ ```mermaid
47
+ sequenceDiagram
48
+ autonumber
49
+ participant 1 as $$\alpha$$
50
+ participant 2 as $$\beta$$
51
+ 1->>2: Solve: $$\sqrt{2+2}$$
52
+ 2-->>1: Answer: $$2$$
53
+ Note right of 2: $$\sqrt{2+2}=\sqrt{4}=2$$
54
+ ```
55
+
56
+ ## Legacy Support
57
+
58
+ By default, MathML is used for rendering mathematical expressions. If you have users on [unsupported browsers](https://caniuse.com/?search=mathml), `legacyMathML` can be set in the config to fall back to CSS rendering. Note that **you must provide KaTeX's stylesheets on your own** as they do not come bundled with Mermaid.
59
+
60
+ Example with legacy mode enabled (the latest version of KaTeX's stylesheet can be found on their [docs](https://katex.org/docs/browser.html)):
61
+
62
+ ```html
63
+ <!doctype html>
64
+ <!-- KaTeX requires the use of the HTML5 doctype. Without it, KaTeX may not render properly -->
65
+ <html lang="en">
66
+ <head>
67
+ <!-- Please ensure the stylesheet's version matches with the KaTeX version in your package-lock -->
68
+ <link
69
+ rel="stylesheet"
70
+ href="https://cdn.jsdelivr.net/npm/katex@{version_number}/dist/katex.min.css"
71
+ integrity="sha384-{hash}"
72
+ crossorigin="anonymous"
73
+ />
74
+ </head>
75
+
76
+ <body>
77
+ <script type="module">
78
+ import mermaid from './mermaid.esm.mjs';
79
+ mermaid.initialize({
80
+ legacyMathML: true,
81
+ });
82
+ </script>
83
+ </body>
84
+ </html>
85
+ ```
86
+
87
+ ## Handling Rendering Differences
88
+
89
+ Due to differences between default fonts across operating systems and browser's MathML implementations, inconsistent results can be seen across platforms. If having consistent results are important, or the most optimal rendered results are desired, `forceLegacyMathML` can be enabled in the config.
90
+
91
+ This option will always use KaTeX's stylesheet instead of only when MathML is not supported (as with `legacyMathML`). Note that only `forceLegacyMathML` needs to be set.
92
+
93
+ If including KaTeX's stylesheet is not a concern, enabling this option is recommended to avoid scenarios where no MathML implementation within a browser provides the desired output (as seen below).
94
+
95
+ ![Image showing differences between Browsers](https://raw.githubusercontent.com/mermaid-js/mermaid/mermaid%4011.16.0/packages/mermaid/src/docs/config/img/mathMLDifferences.png)