Just found out about this the past month.
I like diagrams for my documentation, and I detest making it. I also would like to build it via script, since that's more useful.
Sample:
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
Which produces:
Pretty cool right?
VSCode supports it (load the extension "Markdown Preview Enhanced"), but Jira and Confluence don't support it natively....
But there's a workaround!
In Chrome, load the extension Mermaid Previewer (https://chrome.google.com/webstore/detail/mermaid-previewer/oidjnlhbegipkcklbdfnbkikplpghfdl)
There are a couple of tweaks. For one, you need to enable sandbox mode in the extension.
For Confluence, I put the site as my\.confluence\.site and a selector of pre > code. To add it, I create a markdown block, but within it do this:
```mermaid
graph LR
A --> B
```
(update 2023/10/27) another way that seems to work for confluence is to make a regular code block ( for me, type ``` by hand, then do it with just the "graph LR / A --> B"), and in Mermaid Previewer as div.container, but I don't know how that affects other "containers". the nice thing about doing it the other way is that (for some reason) you HAVE to have the ```mermaid, which means it can't accidentally go crazy with it.
For Jira, my selector is pre.code-java, since by default our code blocks are Java. You can look at the element in Chrome developer mode (right-click, choose "inspect").
Then, within the Jira ticket, just do:
graph LR
A --> B
(NOTE THE SPACES!) No idea why it doesn't act the same between them, but for me it's fine.
No comments:
Post a Comment