Skip to content

Commit f39381c

Browse files
committed
Adding a mermaid diagram docs page
1 parent c60ee5c commit f39381c

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/usage/mermaid-diagrams.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Render Mermaid Diagrams
3+
---
4+
5+
# Rendering Mermaid Diagrams in your Notebooks
6+
7+
If you want to render Mermaid diagrams in your Runme Notebooks it can actually be done pretty easily by installing an extension and using the right syntax.
8+
9+
### Install the VS Code extension
10+
11+
Either from [this link](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) or in the VS Code extension panel, search for "Markdown Preview Mermaid Support".
12+
13+
### Put the following syntax in a Markdown block
14+
15+
<pre>
16+
::: mermaid
17+
graph TD;
18+
A-->B;
19+
A-->C;
20+
B-->D;
21+
C-->D;
22+
:::
23+
</pre>
24+
25+
### You should get a diagram rendering, like the following:
26+
27+
![Mermaid example](/img/mermaid.png)

static/img/mermaid.png

22.5 KB
Loading

0 commit comments

Comments
 (0)