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.
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.
Do you have ticket accessible publicly to track PlantUML feature implementation in GitHub Markdown?
Can you please share the progress?
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:
Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!
If that helps, have a look at embedding images from plantuml servers (slow but it works) :
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:
You can edit this example at https://yuml.me/diagram/scruffy/class/edit/[Customer]->[Billing Address]
Just thought I'd add a note to bump this suggestion. It would be quite useful to be able to track UML changes in a the ARCHITECTURE.md file increasing transparency and community collaboration on open source software architecture.
I agree, should be a good additional feature. Gitlab has it integrated as well and I must say it works effectivly