Skip to content

Latest commit

 

History

History
66 lines (57 loc) · 2.93 KB

usage.md

File metadata and controls

66 lines (57 loc) · 2.93 KB
Raw
layout title
default
usage

Usage

There are a few ways you can use these themes:

  1. You can clone this repo, or you could download just the theme file (*.puml under each theme directory) from the repo. There is one file per theme, so you don't have to worry about copying multiple files. Then you can use the file in two different ways:
  • Using !includefrom within a plantuml markdown file, like so:
!include <path to file>/puml-theme-<THEME NAME>.puml
  • Or you can use it on the command line:
java -jar plantuml.jar -config <path to file>/puml-theme-<THEME NAME>.puml

  1. Use the themes from a URL. Plantuml allows you to include files on the internet with this syntax:

    !include https://raw.githubusercontent.com/bschwarz/puml-themes/master/themes/<THEME NAME>/puml-theme-<THEME NAME>.puml

    All themes have this same format, you can just substitute the name of the theme. For example if I wanted the cerulean theme, then it would look like:

    !include https://raw.githubusercontent.com/bschwarz/puml-themes/master/themes/cerulean/puml-theme-cerulean.puml

    Note in previous versions of plantuml you had to use !includeurl ... syntax to include files from the internet.

Setting Background Color

Currently, the default background color is transparent. However, you can easily set the background color, before you include the theme. For example:

@startuml
!$BGCOLOR="black"

!include https://raw.githubusercontent.com/bschwarz/puml-themes/master/themes/cyborg-outline/puml-theme-cyborg-outline.puml

Bob -> Alice : hello
@enduml

Or if you run from the command line, you can create a separate config file, and set the background color in the config file:

!$BGCOLOR="black"

And then pass the config file on the command line:

java -jar -plantuml /path/to/diagram.puml -config /path/to/background-file -config /path/to/theme-file

Note: background-file should come before theme-file

Overriding skinparams

If you like a theme, but don't like one or more attributes about it, you can override that attribute by just including a skinparam after the theme !include. For example, if you want the title font size to be larger than what the theme has specified, you can just do somethine like:

!include https://raw.githubusercontent.com/bschwarz/puml-themes/master/themes/cerulean/puml-theme-cerulean.puml
.
.
.
skinparam titleFontSize 32

Subpart

You can also use subpart. Subpart is a feature of plantuml that allows you to only use part of a plantuml markdown file. puml-themes also supports this. For example, if you only wanted to use the sequence part of a theme, but have the other diagram types use something different, then you can use this syntax:

!include <path to file>/puml-theme-<THEME NAME>.puml!sequence

The !sequence at the end tells plantuml to only use that section of the config file.