structurizr-INATOR

A reusable Structurizr theme to standardize and simplify diagram styling across multiple projects.

Overview

This repository contains a Structurizr theme (theme.dsl) that defines a consistent set of styles for elements and relationships, including custom icons for popular technologies.

Usage

To use this theme in your Structurizr DSL diagrams, include the following line at the top of your DSL files:

!theme https://raw.githubusercontent.com/StoopidCompany/structurizr-INATOR/main/theme.dsl

This will apply the styles defined in the theme.dsl file to your diagrams.

Example

!theme https://raw.githubusercontent.com/StoopidCompany/structurizr-INATOR/main/theme.dsl

workspace {
    model {
        user = person "User" "An example user."
        softwareSystem = softwareSystem "Example System" "An example software system."

        user -> softwareSystem "Uses" "api"
    }

    views {
        systemContext softwareSystem {
            include *
            autoLayout
        }
    }
}

Assets

The theme uses custom icons for certain elements. These images are stored in the assets directory of this repository. Ensure that the asset URLs in theme.dsl correctly point to these images.

Adding New Styles or Icons

To add new styles or icons:

1. Update theme.dsl: Add your new styles within the appropriate section.
2. Add Assets: Place any new icon images in the assets directory.
3. Commit Changes: Push your updates to the repository so they are accessible.

Example of Adding a New Element with an Icon

element "Helm" {
    icon "https://raw.githubusercontent.com/StoopidCompany/structurizr-INATOR/main/assets/helm.png"
    background #0F1689
    color #FFFFFF
    metadata false
}

Contributing

Contributions are welcome! Please make sure to follow the existing style conventions and ensure any new icons are properly licensed.