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

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.

19 Replies
Community Manager
Message 2 of 20

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 20

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?

Moderator
Message 4 of 20

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!

Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!

Ground Controller Lvl 1
Message 5 of 20

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 3
Message 6 of 20

Re: Support UML diagrams in markdown with plantuml syntax

To save someone a click, the most straightforward way is ![alternative text](http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/sr...) for public repos, and ![alternative text](http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/sr...........) for private repos (i.e. append ?token=........). 

You can get the URL with token by clicking the Raw link when viewing the diagram file. 

 

However this has the major drawback of expiring the token whenever the diagram file is edited. 

Copilot Lvl 2
Message 7 of 20

Re: Support UML diagrams in markdown with plantuml syntax


@jean wrote:

To save someone a click, the most straightforward way is ![alternative text](http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/sr...

If you want to have images automatically reflect the latest version of the diagrams, it's best to insert a flag to not use caching: e.g., 

...proxy?cache=no&src=...

Ground Controller Lvl 1
Message 8 of 20

Re: Support UML diagrams in markdown with plantuml syntax

Lee,

 

In response to "our internal feature request list", I offer the following user story.

 

User Story

 

As a professional software developer, I would like more transparency into the GitHub feature request process, and the opportunity to contribute open source soultions to address such feature requests.

 

Acceptance Criteria

 

1. Feature requests for GitHub are managed in public forum, with ability to up-vote, comment and propose PRs.

2. GitHub has a clearly defined process for accepting contributions, and adding new features to the SaaS.

 

Best regards,

Paul

Community Manager
Message 9 of 20

Re: Support UML diagrams in markdown with plantuml syntax

Thank you kindly for the outline and feedback! I've taken your suggestion and passed it along to the appropriate teams.
I don't have an ETA on when or if this request will be implemented but this is in good hands.

Thank you for your perspective and your contribution!
All the Best

Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!

Copilot Lvl 3
Message 10 of 20

Re: Support UML diagrams in markdown with plantuml syntax

Is this something that could be solved by the new features of "Github actions" ?