How to Use UML Diagrams in GitHub Markdown Documents
The Project Structure
|
+-- UML
| |
| +-- Instance.puml
| ...
|
+-- README.md
...
The Source
Instance <|-- VulkanRootObject
class Instance {
-- Contructors & destructors --
- Instance()
-- Public methods --
+ Initialize() : bool
}
The Link
- PlantUML's proxy:
- Document's GitHub raw URL:
- Combined URL (combine the PlantUML's proxy URL and the document's GitHub raw URL):
The Markdown
![Class Diagram](http://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/Zingam/Markdown-Document-UML-Use-Test/master/UML/Instance.puml)