• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

jonashackt/plantuml-markdown: Example project showing how to use PlantUML and em ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

jonashackt/plantuml-markdown

开源软件地址(OpenSource Url):

https://github.com/jonashackt/plantuml-markdown

开源编程语言(OpenSource Language):


开源软件介绍(OpenSource Introduction):

plantuml-markdown

Example project showing how to use PlantUML and embed UML diagrams into a GitHub markdown

Often the need arises how to create and share UML diagrams for architecture documentation without pain-in-the-**** tools like MS Visio.

After some research, I found this great post about PlantUML. There are simply 2 components you need:

  1. A PlantUML editor - simply use http://www.plantuml.com/plantuml/uml/ (or host your own on-premise with the plantUML Docker image)
  2. Integrate PlantUML render engine with GitHub README.md markdown

1. A PlantUML editor

Visit the online editor http://www.plantuml.com/plantuml/uml/ and write your UML diagram with code & use a cheat sheet like this: https://ogom.github.io/draw_uml/plantuml/

This project contains an example example-uml.iuml:

@startuml
actor client
node app
node car
node tshirt

car -> app
app -> client
client -> tshirt
@enduml

There's also an IntelliJ plugin for PlantUML.

2. Integrate PlantUML render engine with GitHub markdown

This part is simple, yet effective :) Simply use the PlantUML proxy http://www.plantuml.com/plantuml/proxy to render your *.iuml files and embed them like images:

![your-UML-diagram-name](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml)

Use the RAW version of your *.iuml files like that: https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml and prefix it with src=.

Also you should use the cache=no option so that GitHub always renders the currently committed version of your PlantUML *.iuml files.

That's all - simply see the diagram live:

example-uml




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap