Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.41 KB

rolling.md

File metadata and controls

71 lines (56 loc) · 2.41 KB
Raw
layout title
default
rolling

Rolling Your Own Theme

  1. Clone or fork this repo
  2. Create a new directory under the themes/ directory with the name of your theme. For example, if your theme name is sunburst, then there should be a directory called themes/sunburst.
  3. Copy an existing *.puml file (i.e. puml-theme-cerulean.puml) into the new directory, and name it puml-theme-<theme name>.puml
themes/sunburst/puml-theme-sunburst.puml
  1. Open the new file for editing
  2. Change the $THEME variable to the name of your theme.
!$THEME = "sunburst"
  1. Change the $BGCOLOR variable to the default background color of the theme
  2. Proceed to edit the file to make changes to the colors. Most likely you will only need to make changes to the variables that are declared towards the top of the file.
  3. Once all edits are complete, you can generate the images. Preferred format is svg. There is a build scripts in the bin/ directory. You can use the build.sh script on Linux or using git bash on windows. You may have to modify the path to the plantuml.jar file in the script (please do not commit this file after modifying path to script). The first argument to the script is the theme name, and execute it from the root puml-themes directory:
bin/build.sh sunburst

This will save the images into the theme directory. 9. Submit a pull request for the new theme, or you can host it on your own if you want.

Cheers!

Using docker to trigger image build

This creates a small alpine based container with graphviz and related dependencies to run the build.sh or buildall.sh commands to generate images for your theme or for all themes

First build your image

docker-compose build

Then Create an .env file in your workspace with the contents as below; set the THEME variable to the name of your theme

# Specify theme name to be built
# Leave blank or set to 'all' to build all themes
THEME=

Example: to build the carbon-gray theme

# Specify theme name to be built
# Leave blank or set to 'all' to build all themes
THEME=carbon-gray

then run

docker-compose up

This will generate images for your specific theme or all themes if left blank

You can also do the following in lieu of creating a .env file

THEME=carbon-gray docker-compose up

To destroy the container

docker-compose down