Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Highlighted
Copilot Lvl 2
Message 1 of 7

Support UML diagrams in markdown with plantuml syntax

I often have the need for creating UML diagrams when explaining and discussing code, and the plantuml project (see http://plantuml.com) provides a simple syntax for creating such as text. There is a plugin for the Confluence wiki platform that support using this in wiki pages, and it would be great if github's markdown dialect could support something similar.

6 Replies
Moderator
Message 2 of 7

Re: Support UML diagrams in markdown with plantuml syntax

Thanks for this feedback! We're always working to improve GitHub and the GitHub Community Forum, and we consider every suggestion we receive. I've logged your feature request in our internal feature request list. Though I can't guarantee anything or share a timeline for this, I can tell you that it's been shared with the appropriate teams for consideration.

 

Copilot Lvl 2
Message 3 of 7

Re: Support UML diagrams in markdown with plantuml syntax

Do you have ticket accessible publicly to track PlantUML feature implementation in GitHub Markdown?

Can you please share the progress?

Community Manager
Message 4 of 7

Re: Support UML diagrams in markdown with plantuml syntax

Hi @victor-letunovsky,

 

We do not have a public repo for this. We track our feature requests internally. As @lee-dohm mentioned, we can't guarantee anything or share a timeline for if or when this might be implemented. 

If you'd like to keep up to date on new releases and updates to GitHub, I recommend following our blog:

https://blog.github.com/

Cheers!

Ground Controller Lvl 1
Message 5 of 7

Re: Support UML diagrams in markdown with plantuml syntax

If that helps, have a look at embedding images from plantuml servers (slow but it works) :

 

https://stackoverflow.com/questions/32203610/how-to-integrate-uml-diagrams-into-gitlab-or-github

 

Copilot Lvl 2
Message 6 of 7

Re: Support UML diagrams in markdown with plantuml syntax

Constantly getting requests for this gitlab do it, I think, but not really a fan. Would be a great help for project planning, issues etc. ATM version control the source and the PNG.
Ground Controller Lvl 1
Message 7 of 7

Re: Support UML diagrams in markdown with plantuml syntax

You can also try https://yuml.me/ to draw UML diagrams via markdown. For example something like this:

 

![Example UML](https://yuml.me/diagram/scruffy/class/[Customer]->[Billing Address])

 

will render into:

 

d8cd715f

 

You can edit this example at https://yuml.me/diagram/scruffy/class/edit/[Customer]->[Billing Address]