Kakoune-plantuml.kak | command line tool UML to PNG | file-type (puml or plantuml) highlighter

kakoune-plantuml.kak <-- the repo.

PlantUML support for the Kakoune editor.

In order to run PlantUML you need to have installed:

  • Java links to install via sdkman
  • Graphviz (optional if you only need sequence diagrams and activity (beta) diagrams)

PlantUML installation notes faq


mv plantuml.kak ~/.config/kak/autoload/plantuml.kak


plug "KJ_Duncan/kakoune-plantuml.kak" domain "bitbucket.org"

Supported file extensions: (puml|plantuml)

Use PlantUML’s command line syntax to include it in your own scripts or documentation tools.

First, create a text file with PlantUML commands, like this example called sequenceDiagram.puml:

Alice -> Bob: test

Then run PlantUML using sequenceDiagram.puml as input. The output is an image, which either appears in the other software, or is written to an image file on disk.

java -jar plantuml.jar sequenceDiagram.puml

This outputs your sequence diagram to a file called sequenceDiagram.png.


The PlantUML usage instructions have been adapted from their Getting Started page.

Enjoy thank guys. Bye :wave:.

A theme song for the French kakoune users enjoy :smile:

Mickey Kojak covers Art vs Science ‘Parlez Vous Francais?’ for Like A Version on spotify or youtube.

Cool! I wonder if you can get images to display with new multiline replace ranges highlighter and use of something like Überzug

You can embed images in asciidoc demo render or markdown. Just scroll through this single page for quick look overview and some builtin functions.

Its renders static images; PNG, SVG, and LaTex.

Also does ascii-art and unicode, you can use their online server to try before you buy the free open source continuous integration software.


Images (whatever their format : PNG, SVG…) generated by the execution of PlantUML are owned by the author of their corresponding sources code (that is, their textual description in PlantUML language).
So you can use PlantUML comments into your own code : those comments are owned by yourself, and are not considered as covered work, and are not covered by the GPL/LGPL/APL/EPL/MIT license.

Best bit, acknowledges its planet earth:
Screenshot_2020-05-13 Frequently Asked Questions

For non-trivial real-world examples look here.

You could view the static image in the terminal with imagcat.sh.

Hope that helps to clear a few things up, long story short ‘just use it’. Thanks buddy.