Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 3.33 KB

THEMING.md

File metadata and controls

67 lines (47 loc) · 3.33 KB

Theming

Customize your diagrams with themes

SwiftPlantUML generates PlantUML scripts and therefore supports its theming capabilities that are well documented. In a nutshell:

  • None (default theme)
  • Standard themes available in PlantUML
  • Local themes
  • Themes from the Internet

SwiftPlantUML will add the required !theme directive if you specify the respective element in your .swiftplantuml.yml configuration file.

theme: amiga

will result in a generated PlantUML script that contains the !theme directive

@startuml
!theme amiga
class Example {}
@enduml

None / Default Theme

No configuration in .swiftplantuml.yml configuration file is needed.

default

Recommended Standard Themes

PlantUML ships with a variety of themes. Some do not work well with class diagrams. Here is a list of examples that DO work well with class diagrams.

Name Configuration Example
amiga Add theme: amiga as top level element into your .swiftplantuml.yml file
amiga
carbon-gray Add theme: carbon-gray as top level element into your .swiftplantuml.yml file
carbon-gray
cloudscape-design Add theme: cloudscape-design as top level element into your .swiftplantuml.yml file
cloudscape-design
Mars Add theme: mars as top level element into your .swiftplantuml.yml file
mars
minty Add theme: minty as top level element into your .swiftplantuml.yml file
minty
plain Add theme: plain as top level element into your .swiftplantuml.yml file
plain
reddress-darkblue Add theme: reddress-darkblue as top level element into your .swiftplantuml.yml file
reddress-darkblue
sketchy Add theme: sketchy as top level element into your .swiftplantuml.yml file
sketchy
sketchy-outline Add theme: sketchy-outline as top level element into your .swiftplantuml.yml file
sketchy-outline
toy Add theme: toy as top level element into your .swiftplantuml.yml file
toy

Legacy Theme

The previous default theme from PlantUML.

legacy - skin rose

You cannot set this via .swiftplantuml.yml configuration as this is technically not a PlantUML theme.

You have to modify the generated PlantUML script and use skin rose directive.

Example

@startuml
skin rose
class Example {}
@enduml