Skip to content

Commit

Permalink
Adding a mermaid diagram docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
admc committed Nov 21, 2024
1 parent c60ee5c commit f39381c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/usage/mermaid-diagrams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Render Mermaid Diagrams
---

# Rendering Mermaid Diagrams in your Notebooks

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.

### Install the VS Code extension

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".

### Put the following syntax in a Markdown block

<pre>
::: mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
:::
</pre>

### You should get a diagram rendering, like the following:

![Mermaid example](/img/mermaid.png)
Binary file added static/img/mermaid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f39381c

Please sign in to comment.