Skip to content

Instantly share code, notes, and snippets.

@zionyx

zionyx/yuml.markdown

Forked from tobinharris/yuml.markdown
Last active July 8, 2021 09:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save zionyx/d28cb3cfe2b16f8fb181ebaca0a1327e to your computer and use it in GitHub Desktop.
Save zionyx/d28cb3cfe2b16f8fb181ebaca0a1327e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
yuml.markdown

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 markdown codes below

Git users may own repositories.

![](http://yuml.me/diagram/scruffy/class/[Account]++owner-0..*>[Repository])

The may also be collaborators.

![](http://yuml.me/diagram/scruffy/class/[Account]<0..*collab-0..*>[Repository])

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

![](http://yuml.me/diagram/scruffy/class/[Repository]++-1>[TicketSystem],[Repository]++-1>[GitRepo],[Repository]++-1>[PricePlan])

Complex example

  • You can escape spaces with %20 if you need them in the URL.

![](http://yuml.me/diagram/scruffy/class/[note:%20You%20can%20stick%20notes%20on%20diagrams%20too!{bg:wheat}],[Customer]<>1-orders%200..*>[Order],%20[Order]++*-*>[LineItem],%20[Order]-1>[DeliveryMethod],%20[Order]*-*>[Product],%20[Category]<->[Product],%20[DeliveryMethod]^[National],%20[DeliveryMethod]^[International])
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment