The Unreasonable Effectiveness of Sequence Diagrams in MermaidJS

• mermaid-cli

  7 2,031 8.6 JavaScript

  Command line tool for the Mermaid library

  

I'm one of the maintainers of the mermaid-cli project, and unfortunately, no.

Mermaid needs a browser's layout engine to run properly [1], but I haven't yet seen a library that will help us without puppeteer.

And yep, NPM (or another Node.JS package manager) is still needed for installation. I was working on trying to bundle all of mermaid-cli's dependencies (aka Node.JS, puppeteer) into one massive single-file exe last weekend, but it's seems we're blocked by missing features in other packages [2].

If anyone has any ideas on how to implement these things easily, feel free to help-out :) I'm also not a big fan of puppeteer, so I'd love to see a way to go without it.

[1]: https://github.com/mermaid-js/mermaid/issues/3650

[2]: https://github.com/mermaid-js/mermaid-cli/issues/467#issueco...

• text-to-diagram-site

  26 373 6.5 TypeScript

  Compare syntax, layouts, outputs between languages for generating diagrams with text.

  

https://text-to-diagram.com/?example=sequence&b=mermaid

• SurveyJS

  surveyjs.io sponsored

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• d2

  92 15,837 9.8 Go

  D2 is a modern diagram scripting language that turns text to diagrams.

  

• mermaid-mode

  2 167 4.6 Emacs Lisp

  Emacs major mode for working with mermaid graphs https://mermaidjs.github.io/

Currently I generate graph diagrams for papers and blog articles in emacs with graphviz, I wonder how mermaid.js compares in that workflow.

The default styles in mermaid look a little nicer than graphviz, which might be enough to motivate me to try it out. When/if I do, I'll probably try with this emacs package: https://github.com/abrochard/mermaid-mode.

• plantuml-examples

  3 174 4.4

  PlantUML eaxmples for UML, ERD, wireframes, mind maps, JSON, YAML, WBS, ASCII art, Gantt charts, C4 models, and more

More examples of these with renderings of dividers, actors, databases, etc.:

https://github.com/joelparkerhenderson/plantuml-examples

• goldmark-mermaid

  1 38 7.6 Go

  Mermaid diagram support for Goldmark Markdown parser.

• mermaid

  122 66,838 10.0 JavaScript

  Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

  

I'm one of the maintainers of the mermaid-cli project, and unfortunately, no.

Mermaid needs a browser's layout engine to run properly [1], but I haven't yet seen a library that will help us without puppeteer.

And yep, NPM (or another Node.JS package manager) is still needed for installation. I was working on trying to bundle all of mermaid-cli's dependencies (aka Node.JS, puppeteer) into one massive single-file exe last weekend, but it's seems we're blocked by missing features in other packages [2].

If anyone has any ideas on how to implement these things easily, feel free to help-out :) I'm also not a big fan of puppeteer, so I'd love to see a way to go without it.

[1]: https://github.com/mermaid-js/mermaid/issues/3650

[2]: https://github.com/mermaid-js/mermaid-cli/issues/467#issueco...

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• d2-playground

  23 62 6.5 JavaScript

  An online runner to play, learn, and create with D2, the modern diagram scripting language that turns text to diagrams.

  

https://play.d2lang.com/?script=qlDQtVOo5AIEAAD__w%3D%3D&ske...

I was going to ask why you don't have a web version but you already do. I'm going to play with this more today.

Have you thought about an "auto compile"/live mode where it changes as you edit the text? I think this adds a level of intuitiveness that would help new users explore.

• jsdom

  55 19,954 7.8 JavaScript

  A JavaScript implementation of various web standards, for use with Node.js

  

• zipkin

  36 16,729 9.4 Java

  Zipkin is a distributed tracing system

  

For microservice tracing, you might want to look at Zipkin [0], or OpenTelemetry [1]

[0] https://zipkin.io/

• autoapps

  1 1 6.8 Python

Suggest a related project