Markdown extensions !
It is often essential to integrate diagrams into internal documentation of your project. UmlSync provides an ability to insert diagrams into markdown documentation.
There are 3 reference types:
- Relative path:
![Diagram: ] (http://umlsync.org/github?path=./file.umlsync "")
- Absolute path:
![Diagram: ] (http://umlsync.org/github/umlsynco/diagrams/master/diagrams/ElementInitialization.umlsync "")
- SHA path
![Diagram: ] (http://umlsync.org/github/repos/umlsynco/diagrams/git/blobs/9974fbe3ef6690d32064f753d962d661b1fc7384?1385219431501 "")
All paths are based on github’s paths. You could easily replace “http://umlsync.org/github” on “https://github.com” and open the resource on Github directly.
For more information about embedded diagrams see:
http://umlsync.org/github/umlsynco/diagrams/master/examples/EmbeddedDiagrams.md example.