Instantly share code, notes, and snippets.

Embed
What would you like to do?

yUML Test On GitHub

yUML is a simple tool for embedding UML diagrams in wikis and blogs without needing any UML or diagramming tools.

Here's an idea of how it could be used in your repository readme.markdown or wiki.

View the RAW source to see how images are made.

Example

Git users may own repositories.

The may also be collaborators.

Each repositories have a Git repository, a ticketing system and a price plan.

@torarnv

This comment has been minimized.

torarnv commented Oct 14, 2015

Hmm, the GitHub markdown renderer seems to fail to parse this 😢

@laurelnaiad

This comment has been minimized.

laurelnaiad commented Dec 16, 2015

It works if you escape the the greater than signs (except for the ones that are used to close the img elements).

In my editor (atom), I can do this with a find/replace in regex mode as

find: [^\/](>)
replace with: >

... resulting in... (here is a gist to that can be viewed raw if the description above isn't clear enough: https://gist.github.com/laurelnaiad/ae2b2f25390f04bb8495)

yUML is a simple tool for embedding UML diagrams in wikis and blogs without needing any UML or diagramming tools.

Here's an idea of how it could be used in your repository readme.markdown or wiki.

View the RAW source to see how images are made.

Example

Git users may own repositories.

The may also be collaborators.

Each repositories have a Git repository, a ticketing system and a price plan.

@deanturpin

This comment has been minimized.

deanturpin commented Apr 26, 2016

Or use the proper markdown syntax for embedded images.

![](http://yuml.me/diagram/scruffy/class/[Customer]<>1->*[Order] "yUML")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment