- Notifications
You must be signed in to change notification settings - Fork23
HowTo | UML in Wiki
ML-TANGO edited this pageOct 6, 2022 ·5 revisions
References:
First create *.pulm file in the GitHub repo (e.g., docs/test.puml`) and add following puml code in the file.For example,
@startuml'https://plantuml.com/class-diagraminterface MemberServiceinterface MemberRepositoryclass MemoryMemberRepositoryMemberRepository -- MemberServiceMemberRepository <|-- MemoryMemberRepository@enduml- you can edit puml content at onlinePUML Server and the copy the codes into your
repo/docs/test.pumlfile - Online pulm server you should wrap you uml code with
@startuml ... @endumlbut removes itrepo/docs/test.pumlfile
Then, in your Markdown Wiki, insert UML rendering images using Plant UML proxy functionhttp://www.plantuml.com/plantuml/proxy as follows:
Note that the value ofsrc paramter for Plant UML proxy call should have following pattern; https://raw.githubusercontent.com instead ofhttps://github.com/ and remaining URL parts use following syntax.
https://raw.githubusercontent.com/:owner/:repo/:branch/:file_path:owner:: your GitHub Id:repo:: repository name of yours:brach:: branch name in the repository:file_patt:: puml file path in the repository
Then, Plant UML proxy (http://www.plantuml.com/plantuml/proxy`) is called withtest.puml file in your GitHub repo and renering result will be returned.
Final Result:
👉Note
- This page might contain some wide rendered images. If you want to see the whole contents with wider page, please useWide GitHub extension of Chrome.
- If you are experiencing the error on rendered images due to the low-bandwith Internet delay, please use F5 function key for refreshing current page.