Edit in DokuwikiEdit in AsciidocEdit in Markdown

Themes

Following the work from Brett Schwarz, we have integrated several themes into the main core library.

Since those themes are included into the library, it is working out of the box: you don't need to install anything on your side. You just have to use the !theme directive:

🎉 Copied!

@startuml !theme spacelab class Example { Theme spacelab } @enduml

🎉 Copied!

@startuml !theme spacelab a -> b b -> c @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

List of available themes

Several websites are listing available themes:

• Gallery of all official PlantUML themes.
• Examples of some Puml Themes made by Brett Schwarz on the Theme Gallery.

Finally, you can list all available themes from your PlantUML library:

🎉 Copied!

@startuml help themes @enduml

Or you can use the %get_all_theme builtin function to retreive a JSON array of all PlantUML theme.

🎉 Copied!

@startjson %get_all_theme() @endjson

Available from version 1.2024.4.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Coloring message with some procedures included on some theme

Some theme includes some procedures, to help coloring message, as:

• $success("<msg>")
• $failure("<msg>")
• $warning("<msg>")

Example:

🎉 Copied!

@startuml !theme spacelab Bob -> Alice : hello Bob <- Alice : $success("success: hello B.") Bob -x Alice : $failure("failure") Bob ->> Alice : $warning("warning") @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Local themes

You can create your own theme on your local file system. You can duplicate any existing theme to create your own one.

By default, a theme file is named puml-theme-foo.puml where foo is the name of the theme.

To invoke a local theme, you have to use the following directive:

!theme foo from /path/to/themes/folder

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Themes from the Internet

Other repositories can also publish themes for PlantUML.

Theme files must follow the same convention: puml-theme-foo.puml where foo is the name of the theme.

To use a theme from a remote repository, you have to use the following directive:

!theme amiga from https://raw.githubusercontent.com/plantuml/plantuml/master/themes

If you find any interesting theme, you can also propose a pull request so that we integrate this theme into the main core library.