{"id":16179257,"url":"https://github.com/jonashackt/plantuml-markdown","last_synced_at":"2025-04-07T11:43:19.514Z","repository":{"id":147269999,"uuid":"216736986","full_name":"jonashackt/plantuml-markdown","owner":"jonashackt","description":"Example project showing how to use PlantUML and embed UML diagrams into a GitHub markdown","archived":false,"fork":false,"pushed_at":"2020-02-24T14:22:54.000Z","size":3,"stargazers_count":98,"open_issues_count":0,"forks_count":93,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-13T14:24:08.214Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonashackt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-22T06:16:37.000Z","updated_at":"2024-12-12T16:07:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"5e72e346-54de-4fa6-b531-3a4b3a94d059","html_url":"https://github.com/jonashackt/plantuml-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonashackt%2Fplantuml-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonashackt%2Fplantuml-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonashackt%2Fplantuml-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonashackt%2Fplantuml-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonashackt","download_url":"https://codeload.github.com/jonashackt/plantuml-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648923,"owners_count":20972942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T05:26:27.175Z","updated_at":"2025-04-07T11:43:19.494Z","avatar_url":"https://github.com/jonashackt.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# plantuml-markdown\nExample project showing how to use PlantUML and embed UML diagrams into a GitHub markdown\n\nOften the need arises how to create and share UML diagrams for architecture documentation without pain-in-the-**** tools like MS Visio.\n\nAfter some research, I found [this great post about PlantUML](https://blog.anoff.io/2018-07-31-diagrams-with-plantuml/). There are simply 2 components you need:\n\n1. A PlantUML editor - simply use [http://www.plantuml.com/plantuml/uml/](http://www.plantuml.com/plantuml/uml/) (or host your own on-premise with the [plantUML Docker image](https://hub.docker.com/r/plantuml/plantuml-server/))\n2. Integrate PlantUML render engine with GitHub `README.md` markdown\n\n### 1. A PlantUML editor\n\nVisit the online editor [http://www.plantuml.com/plantuml/uml/](http://www.plantuml.com/plantuml/uml/) and write your UML diagram with code \u0026 use a cheat sheet like this: https://ogom.github.io/draw_uml/plantuml/\n\nThis project contains an example [example-uml.iuml](example-uml.iuml):\n\n```\n@startuml\nactor client\nnode app\nnode car\nnode tshirt\n\ncar -\u003e app\napp -\u003e client\nclient -\u003e tshirt\n@enduml\n```\n\nThere's also [an IntelliJ plugin for PlantUML](https://plugins.jetbrains.com/plugin/7017-plantuml-integration/).\n\n### 2. Integrate PlantUML render engine with GitHub markdown\n\nThis 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:\n\n```\n![your-UML-diagram-name](http://www.plantuml.com/plantuml/proxy?cache=no\u0026src=https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml)\n``` \n\nUse the `RAW` version of your `*.iuml` files like that: [https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml](https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml) and prefix it with `src=`.\n\nAlso you should use the `cache=no` option so that GitHub always renders the currently committed version of your PlantUML `*.iuml` files.\n\nThat's all - simply see the diagram live:\n\n![example-uml](http://www.plantuml.com/plantuml/proxy?cache=no\u0026src=https://raw.githubusercontent.com/jonashackt/plantuml-markdown/master/example-uml.iuml)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonashackt%2Fplantuml-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonashackt%2Fplantuml-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonashackt%2Fplantuml-markdown/lists"}