kb:common:plantuml
Table of Contents
PlantUML
Local Rendering
For local rendering of PlantUML diagrams into image files (eg. from our Release Automation Tools), additional tools are required. One option is using Graphviz.
Notepad++ Integration
The following paragraphs use npp as an abbreviation for Notepad + +
Installing PlantUML for //npp//
-
install java
-
create
plantuml.bat
@echo off java -jar Z:\plantUML\plantuml.jar -charset UTF-8 -o "C:\Users\Public\Pictures" %1
-
Menu execute –> run external program
-
insert
cmd PathToYour\PlantUML\plantuml.bat “$(FULL_CURRENT_PATH)”
Previewing Diagrams
PlantUmlViewer: A plugin to generate, view and export PlantUML diagrams.
-
Use the built-in Plugins Admin to install it directly.
-
Just open npp and navigate to Plugins > Plugins Admin.
-
Here under the Available tab, search for PlantUML Viewer.
-
After checking the corresponding box, click Install at the top right corner of the window.
Syntax Highlighting
PlantUML_Notepad-_UDL: A user defined language (UDL) for npp to support the PlantUML language syntax.
-
Download UDL from URL above
-
move UDL to folder for import
-
%AppData%\Notepad++\userDefineLangs
restart npp
VS Code Integration
-
Install the extension “PlantUML”.
-
Go to the extension settings and make the following changes:
-
Renderer: “PlantUMLServer”
-
Server: “http://localhost:8123” (or another server URL).
Open a new file and add a PlantUML script.Open the preview windows by pressingAlt + D.
PlantUML Server
Docker locally (the easy way!)
-
Install Docker (Linux) or Docker-Desktop (Windows). If not included, install Docker Compose.
-
Clone the “HSE PlantUML Server” docker compose script with
git clone git@gitlab.com:hampel-soft/hse-labs/hse-plantuml-server.git. -
Open a terminal in the project folder.
-
Execute
docker-compose up -d(für Compose v2:docker compose up -d) -
Open a browser and type in
http://localhost:8123. The PlantUML site with an input field and some example code should be displayed.
Docker on Synology NAS
-
in docker webinterface register & download plantuml/plantuml-server
-
under image start image
-
configure a local port
-
create firewall rule for that port in synology DS
-
[create port forwarding rule for that port in router]
-
kb/common/plantuml.txt · Last modified: 2026/07/14 15:57 by joerg.hampel
-
-