NOTE Themes are now built into plantuml, so you don’t necessarily need puml-themes anymore, can use the themes directly within plantuml. The only reason why you might still use this package is if you are stuck on an old version of plantuml.
Introduction
puml-themes is a repo for some themes for the great plantuml diagraming tool, which takes a markdown type text file and converts it into an image of a diagram. The reason why you might use plantuml is for several reasons:
- Sometimes it’s easier to use text markdown then a full fledge GUI diagramming tool.
- Having text in a source control repo is more convenient since you can track changes easier.
- It’s easy to auto generate the diagrams.
However, the out of the box color scheme for plantuml is not very pleasing to the eyes (at least to me). That and the fact you may want to match your diagrams with the rest of your documentation (as in my case) lead me to put together some themes.
note the themes files use some of the newer syntax from plantuml, so you will need to use at least version
1.2020.8. If you can not use that version, then you can download the puml file from this repo, and edit it, and replace each instance of !procedure with !function and !endprocedure with !endfunction
Usage
There are a few ways you can use these themes:
-
You can clone this repo, or you could download just the theme file from the repo. There is one file per theme, so you don’t have to worry about copying multiple files.
-
Use the themes from a URL. Plantuml allows you to include files on the internet with this syntax:
See Usage page for more details
Themes
black-knight
Hacker theme based off of Black Knight colors
bluegray
Blue and Gray theme
cerulean
Blue based theme based off of the Cerulean theme at bootswatch
cerulean-outline
Blue based theme based off of the Cerulean theme at bootswatch, but with only outline colors no fill (transparent)
cyborg
Dark theme meant for dark backgrounds based off of the Cyborg theme at bootswatch
