RESTful rendering pipeline for generating sequence and UML diagrams using Mermaid to embed in Github readmes, Markdown docs and more! Mermrender uses Mermaid.JS and Mermaid CLI under the hood.
Feel free to contribute by making a pull request!
Maintainer: [email protected]
Run Mermrender in Gitpod, a free online dev environment for GitHub:
https://3000-cebcfedc-d281-4f38-b13a-cc6312da177b.ws-us0.gitpod.io/diagram/2VxdWVuY2VEaWF
Check out this awesome guide for setting up diagram rendering within VSCode: https://quintussential.com/archive/2017/12/10/Diagraming-with-Mermaid/
Github doesn't support rendering Mermaid diagrams in their Markdown editor. Mermaid is a powerful tool that uses a well-defined schema to then interpret diagrams into an SVG. The idea of this tool is to allow embedding images dynamically via a REST endpoint to add UML/Sequence diagrams into your documentation/readmes/markdown files easily, whether the editor supports Mermaid or not.
sequenceDiagram
participant A as Alice
participant J as John
A->>J: Hello John, how are you?
J->>A: Great!
or
@startuml
object Object01
object Object02
object Object03
object Object04
object Object05
object Object06
object Object07
object Object08
Object01 <|-- Object02
Object03 *-- Object04
Object05 o-- "4" Object06
Object07 .. Object08 : some labels
@enduml
You can edit and render them live on this website: https://mermaidjs.github.io/mermaid-live-editor/
Next, you need to run it through an escaper like the following: https://www.freeformatter.com/java-dotnet-escape.html#ad-output
Send a POST request to http://localhost:3000/encode/plantuml or http://localhost:3000/encode/mermaid depending on the type with a diagram key in the body with the above escaped diagram:
Example Body:
{
"diagram": "sequenceDiagram\r\n participant Alice\r\n participant Bob\r\n Alice->>John: Hello John, how are you?\r\n loop Healthcheck\r\n John->>John: Fight against hypochondria\r\n end\r\n Note right of John: Rational thoughts <br/>prevail...\r\n John-->>Alice: Great!\r\n John->>Bob: How about you?\r\n Bob-->>John: Jolly good!"
}
This will generate a respose:
{
"embed_link": "http://localhost:3000/diagram/2VxdWVuY2VEaWF"
}
You can embed the following embed_link by using the following syntax:
<img src="http://localhost:3000/diagram/2VxdWVuY2VEaWF"/>
[img]http://localhost:3000/diagram/2VxdWVuY2VEaWF[/img]
Add the following optional query parameters to add custom dimensions to your images:
(Not yet implemented)
npm ito install dependenciesnode index.jssudo npm install -g node-plantumlsudo npm install -g mermaid.cli
or run Mermrender in Gitpod, a free online dev environment for GitHub:
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent