Include diagrams in your Markdown files with Mermaid

1

asciiflow

This is interesting, but I personally really like that markdown is almost as legible as plain text as when rendered, which things like this sort of break. So I think I'd prefer ASCII art diagrams for this sort of thing. (In fact there was recently an ASCII diagram drawing tool on the front page, https://asciiflow.com/ ).

#Diagrams #Flowcharts #UML 30 social mentions

2

Kroki

Re: https://github.com/github/markup/issues/533 I’m the main author of KeenWrite (see screenshots), a type of desktop Markdown editor that supports diagrams. It’s encouraging to see that Mermaid diagrams are being supported in GitHub. There are a few drawbacks on the syntax and implications of using MermaidJS. First, only browser-based SVG renderers can correctly parse Mermaid diagrams. I’ve tested Apache Batik, svgSalamander, resvg, rsvg-convert, svglib, CairoSVG, ConTeXt, and QtSVG. See issue 2485. This implies that typesetting Mermaid diagrams is not currently possible. In effect, by including Mermaid diagrams, many documents will be restricted to web-based output, excluding the possibility of producing PDF documents based on GitHub markdown documents (for the foreseeable future). Second, there are numerous text-to-diagram facilities available beyond Mermaid. The server at https://kroki.io/ supports Mermaid, PlantUML, Graphviz, byte fields, and many more. While including MermaidJS is a great step forward, supporting Kroki diagrams would allow a much greater variety. (Most diagrams produced in MermaidJS can also be crafted in Graphviz, albeit with less terse syntax.) Third, see the CommonMark discussion thread referring to a syntax for diagrams. It’s unfortunate that a standard “namespace” concept was not proposed. Fourth, KeenWrite integrates Kroki. To do so, it uses a variation on the syntax: <pre><code> ``` diagram-mermaid.

#Diagrams #Flowcharts #Prototyping 31 social mentions

#Diagrams #Flowcharts #Prototyping 5 social mentions

4

DIagrams Through Ascii Art

It would be nice to have this tool: http://ditaa.sourceforge.net/ So ASCII drawings could be rendered into pretty ones.

#Diagrams #Flow Charts And Diagrams #Flowcharts 8 social mentions

5

Textik

#Development #Diagrams #Flowcharts 5 social mentions

6

Graphviz

#Diagrams #Flowcharts #Flow Charts And Diagrams 79 social mentions

7

Markdeep

Http://casual-effects.com/markdeep/ has had ASCII-art-as-vector-image features for quite some time now. It's in need of a good editor, though.

#Competitive Intelligence #Data Profiling #Resource Profiling And Monitoring 25 social mentions

8

HackMD

This brings one of my favorite features from https://hackmd.io (a site that I still love for early collaboration). I still love hackmd for its "gists on steroids", though I wish it had included git hosting.

#Task Management #Productivity #Project Management 62 social mentions

9

HedgeDoc

Shoutout for Hedgedoc a fork of CodiMD - Hedgedoc supports Mermaid already next to a lot of other markdown syntax: https://hedgedoc.org/.

#Office & Productivity #Tool #Markdown Editor 30 social mentions

10

Obsidian.md

Https://obsidian.md/ can also render Mermaid diagrams.

#Knowledge Management #Knowledge Base #Markdown Editor 1453 social mentions

11

Markdown by DaringFireball

We should not forget, that the "spirit of Markdown is": > Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). Inventor of Markdown https://daringfireball.net/projects/markdown/.

#Markdown Editor #Text Editors #Office & Productivity 79 social mentions