Structurizr

Structurizr builds upon "diagrams as code", allowing you to create multiple software architecture diagrams from a single model. There are a number of tools for creating Structurizr compatible workspaces, with the Structurizr DSL being the recommended option for most teams.

The Structurizr extension allows individual views from a Structurizr DSL workspace to be included in Asciidoc documents. This is the inverse use case of Structurizr’s documentation support which lets you embed Asciidoc in the Structurizr DSL.

This extension uses the Structurizr CLI tool to convert Structurizr DSL files into the input for a renderer. The chosen renderer is then used to generate the final image.

The installation location of Structurizr CLI needs to be passed to asciidoctor-diagram using the DIAGRAM_STRUCTURIZRCLI_HOME. It should be set to the absolute directory containing the extracted Structurizr CLI archive.

Supported Image Formats

  • PNG

  • SVG

Attributes

Name Default value Description

renderer

plantuml-c4

The rendering backend to use. One of d2, graphviz, mermaid, plantuml, or plantuml-c4

view

unspecified

The key of the view to render