Skip to content

orien/puml-themes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PlantUML Themes

A collection of beautiful, professionally designed themes for PlantUML diagrams. Create stunning documentation with consistent styling and color palettes that enhance readability and visual appeal.

🎨 Available Themes

Solarized Light

A carefully crafted light theme based on Ethan Schoonover's acclaimed Solarized color palette. This theme provides excellent readability and a professional appearance for all your PlantUML diagrams.

Features:

  • Optimized color contrast for better readability
  • Professional appearance suitable for documentation
  • Based on the popular Solarized color scheme

Solarized Dark

A dark variant of the Solarized theme, perfect for dark mode environments and reducing eye strain in low-light conditions. Built on the same acclaimed Solarized color palette with inverted base colors for a sophisticated dark appearance.

Features:

  • Dark background with light text for comfortable viewing in low-light environments
  • Maintains the same excellent color contrast as Solarized Light
  • Perfect for dark mode documentation and presentations
  • All diagram types fully supported with consistent dark styling

📦 Installation & Usage

Quick Start

  1. Download the theme file:

    # For light theme
    wget https://raw.githubusercontent.com/orien/puml-themes/main/themes/puml-theme-solarized-light.puml
    
    # For dark theme
    wget https://raw.githubusercontent.com/orien/puml-themes/main/themes/puml-theme-solarized-dark.puml
  2. Include in your PlantUML diagram:

    @startuml
    !include puml-theme-solarized-light.puml
    ' Or for dark theme: !include puml-theme-solarized-dark.puml
    
    Alice -> Bob: Hello
    Bob --> Alice: Hi!
    @enduml

Local Installation

  1. Clone this repository:

    git clone https://github.com/orien/puml-themes.git
  2. Reference the theme in your diagrams:

    @startuml
    !include ./puml-themes/themes/puml-theme-solarized-light.puml
    
    participant User
    participant System
    participant Database
    
    User -> System: Request data
    System -> Database: Query
    Database --> System: Results
    System --> User: Response
    @enduml

Remote Include (Recommended)

For the latest version, include directly from the repository:

@startuml
' Use Solarized Light theme
!include https://raw.githubusercontent.com/orien/puml-themes/main/themes/puml-theme-solarized-light.puml

' Or use Solarized Dark theme
' !include https://raw.githubusercontent.com/orien/puml-themes/main/themes/puml-theme-solarized-dark.puml

' Your diagram content here
@enduml

🖼️ Gallery

Sequence Diagrams

Both Solarized themes provide beautiful styling for sequence diagrams with clear participant boxes, readable fonts, and subtle color accents.

Solarized Light Gallery: See the full gallery in themes/puml-theme-solarized-light.md

Solarized Dark Gallery: See the full gallery in themes/puml-theme-solarized-dark.md

⚙️ Customization

Font Configuration

You can customize the font family and size by setting variables before including the theme:

@startuml
!$FONT_NAME = "Arial"
!$FONT_SIZE = 14
!include puml-theme-solarized-light.puml

' Your diagram here
@enduml

Available Variables

  • $FONT_NAME - Font family (default: "Verdana")
  • $FONT_SIZE - Base font size (default: 12)
  • $TITLE_SIZE - Title font size (automatically calculated as $FONT_SIZE + 4)

🛠️ Development Tools

This repository includes powerful tools for theme development and gallery generation:

Gallery Generation

  • Location: tools/gallery-generation/
  • Purpose: Automatically generate visual galleries of themes applied to different diagram types
  • Usage: Creates comparison images for documentation and testing

📚 Resources

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Acknowledgments

  • Ethan Schoonover for the original Solarized color palette
  • The PlantUML community for creating an amazing diagramming tool
  • Contributors who have helped improve and expand this theme collection

Made with ❤️ for the PlantUML community

About

Solarized PlantUML themes

Topics

Resources

License

Stars

Watchers

Forks

Languages