Support UML diagrams in markdown with plantuml syntax

Joining the vote - this is a much needed feature.

In the meantime :

  1. I found this Chrom / Firefox extension to work really well:

    https://github.com/WillBooster/plantuml-visualizer

    - Examples of how this looks in markdown files

       https://github.com/uri-chandler/makeitpdf/blob/master/examples/internet-banking-system/Context.md

       https://github.com/uri-chandler/makeitpdf/blob/master/examples/internet-banking-system/Containers.md

       https://github.com/uri-chandler/makeitpdf/blob/master/examples/internet-banking-system/Components.md

    - More examples can be found in the project’s original GitHub repo

  1. [#shameless #plug]

     I wrote this CLI tool specifically for the purpose of adding documentation which is  close-to-code

     https://github.com/uri-chandler/makeitpdf

     - Supports nested Markdown files

     - Renders PlantUML diagrams (your own server, or the public PlantUML one)

     - Auto Table-Of-Content

3 Likes

Planttext is mentioned as just an online editor for plantUML but you can export a URL for the diagram. like this:

https://planttext.com/api/plantuml/png/F8yn3i8m34LtdyBAtWim8AGY8GQcK7Ls6wj4QfCIfqFFni2Hk089QPci_v_i9tzUxvD42d6PHe1euyYeRYn20mjMgFcviEiPpvQ6G9C2e3xwW8rmWCulpb1OKRNSuQMvAYJ94thlOl0ZAltmyspTW7MI_B2kWLqohTXQCt04Gv4w4jwo0EJZM1tp9JpWtUCkWjmaeElIRnf8ERLblv2YWAtwGobqLmASs9dq-nS00F__0m00

Please add this feature :bowing_man:

3 Likes

This is a great article on including PlantUML in your documentation on Github:

1 Like

I believe that supporting diagrams-as-text on GitHub would result in more widespread adoption of the technology in the industry, which would benefit us all. As they say, one good image says thousand words.

1 Like

I vote up, diagrams as a text is must-have for documentation.

3 Likes

Adding another vote to this!

I also vote for this, but given the age of this ticket I’m not too optimistic.
Likely >/dev/null, alas. :man_shrugging:

Anyway…

I’ve not tried it yet but what GitLab are offering (simple plantuml code block inline in markdown) looks amazing. However, for the time being at least, I work for a GitHub-first organisation - so would love to see GitHub keep up with the competition.

A picture can be worth a thousand words, as they say. Please make this happen for us. :pray:

Another vote on this. I really want diagrams as code, right there in the repo.

2 Likes

Please, add native support for PlantUML - “diagram as code” is trackable and at the end of the day makes explanations (documentation, etc…) easier and more concise.

+100

1 Like

This would be a really nice feature!
Having to manually generate the PNGs of rendered diagrams and manually update it is a real pain.

Could be Markdown rendering for PlantUML, Mermaid or similar…

Cheers!

This is a very important feature to have. It would allow the repositories to have less binary files and more data that can be traced in the commits. Would also help to add/join documentation in the same project and help give visibility on how things work on the them.

1 Like

This does not work, the github token expires after a very short period of time, so you just end up with lots of broken image links.

We even went so far as to create a proxy we could deploy as a service and also to hopefully shame github into adding plantuml support.

The amount of hours lost with people using 10 different diagramming tools when this could be solved so easily by github with 0.00001 % of their annual budget.

1 Like

Adding a vote to this issue.

Or even add Mermaid support if PlantUML is too much bother. Anything is better than nothing.