Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for kroki/pikchr #4375

Open
7 tasks done
goyalyashpal opened this issue May 26, 2023 · 2 comments · May be fixed by #4381
Open
7 tasks done

Support for kroki/pikchr #4375

goyalyashpal opened this issue May 26, 2023 · 2 comments · May be fixed by #4381
Labels
feature This is a completely new feature for Zettlr.

Comments

@goyalyashpal
Copy link

Checklist

  • Zettlr does not possess this feature (if it does, but the feature doesn't work out for you, propose an enhancement instead.)
  • Zettlr's current features cannot be used to approximate this behaviour (otherwise, propose an enhancement instead.)
  • I have searched the documentation to make sure I did not overlook it.
  • I have searched both open and closed issues to see if someone has already proposed this.

Feature Proposal

Zettlr has mermaid for rendering diagrams. But mermaid is very streamlined, hence doesn't offer much flexibility in the layout of things it renders.

Pikchr (pronounced "picture") is a PIC-like markup language for diagrams in technical documentation. Pikchr is designed to be embedded in fenced code blocks of Markdown or similar mechanisms of other documentation markup languages.
https://pikchr.org/home/doc/trunk/homepage.md

Creates diagrams from textual descriptions!
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, TikZ, UMLet, Vega, Vega-Lite, WaveDrom, WireViz... and more to come!

Example Workflow

Drawing charts (hybrid of flowchart, and block/sequence diagram) which require arrows going perpendicular between different nodes.

Caveats

I don't think there would be any caveats other than the bare technical implementations.

Based on what it kroki says about "provides a unified API with support for ...", it will only increase the availability of other features.

Do you wish to attempt implementing this yourself?

No

Platforms

  • Windows
  • macOS
  • Linux

Additional Information

Pasting image links from that issue over here:

dummy-flowchart

@goyalyashpal goyalyashpal added the feature This is a completely new feature for Zettlr. label May 26, 2023
@UFOMelkor
Copy link
Contributor

@nathanlesage Kroki offers a public API on kroki.io (that can be self-hosted). So an Implementation would not need another package, but I guess the images will need to be cached. Is such a cache already implemented?

@nathanlesage
Copy link
Member

There's no image cache besides the standard Chrome one, no.

@UFOMelkor UFOMelkor linked a pull request May 30, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is a completely new feature for Zettlr.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants