markup VS kroki

Btw github supports more than just markdown: https://github.com/github/markup#markups

I'm not sure 4. works for colors/styling, style attributes are stripped: https://github.com/github/markup/issues/119

I found this issue, which does not show much traction: https://github.com/github/markup/issues/994

For sharing settings and lore with players, GitHub wiki. Understands Org and several other formats thanks to GitHub Markup, so I can copy in (and trim down) my original notes without much fuss.

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:

    ``` diagram-mermaid

I thought it only rendered files in the repo (match by extension). Does GH also allow asciidoc(tor) syntax in comments and issues?

* Note: Sadly, include is not supported on GH. https://github.com/github/markup/issues/1095

Your wish showing up in the face of a submission just 14 days ago and then another 29 days ago must be indicative of why there are so many dupes all the time: https://news.ycombinator.com/from?site=kroki.io

You can feel free to submit the GH repo, as that one doesn't seem to have been submitted before https://github.com/yuzutech/kroki

Pikchr https://pikchr.org/home/pikchrshow is the other general purpose one and older than d2. It is "Source-Code License: 0-clause BSD" as it says on the page.

Someone made it into wasm and put playground for pikchr here https://www.jakethaw.com/pikchr_webassembly_demo/

Can also try pikchr online here on https://kroki.io/#try which is hosting many other text to diagram tools as well.

I use mermaid.js heavily, but plug for Kroki:

https://kroki.io/

“Kroki provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, Structurizr, SvgBob, Symbolator, TikZ, UMLet, Vega, Vega-Lite, WaveDrom, WireViz... and more to come!”

If you don't mind my asking, what aspects of "acceptable layout" is usually the first to get busted?

I'm extremely excited about using WireViz[1] to automate wiring harness diagram creation, and if I can, I'd like to know the speedbumps before I hit them. I'm thinkin generous linking between diagrams will be one path.

[1] Project:: https://github.com/wireviz/WireViz SandboxP:: https://kroki.io/#try [select Diagram>WireViz]

The SVG output is embedded into the PDF file.

https://kroki.io/examples.html#mind-map

Kroki has other text-based formats for flow charts, Gantt charts, UML diagrams, packet diagrams, network diagrams, word clouds, etc.

My cross-platform desktop text editor, KeenWrite, allows users to define variables in an external YAML file. The editor calls out to Kroki[1] to convert text-based diagrams to SVG. The diagrams can reference variables and are rendered using EchoSVG[2].

KeenWrite[3] can produce PDF documentation from Markdown documents that has PlantUML diagrams with elements stored in an external, machine-readable file. Here are screenshots showing variables on the left, diagram text in the middle, and a real-time render on the right:

* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...

* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...

KeenWrite supports all diagrams offered by Kroki, which includes "diagram-plantuml".

[1]: https://kroki.io/

[2]: https://github.com/css4j/echosvg/

[3]: https://github.com/DaveJarvis/keenwrite