plantuml-stdlib/C4-PlantUML
C4 PlantUML
C4-PlantUML is a code-driven library that generates C4 model software architecture diagrams from PlantUML source text. It provides a set of reusable macros for creating system context, container, component, and deployment diagrams, enabling architects and developers to describe and communicate software architecture using the C4 model notation directly from diagram-as-code source files.
The library distinguishes itself through hierarchical element nesting, which builds diagrams by nesting elements inside boundaries using PlantUML's rectangle and package constructs, and layout-direction control that enforces a consistent reading flow across all diagram types. It embeds color-coded legends directly into the drawing canvas, integrates with PlantUML's sequence diagram syntax to model time-ordered message flows, and renders person and system elements using embedded sprite definitions for consistent, scalable icons. Tag-driven visual styling allows custom colors, line styles, and shapes to be applied by mapping user-defined tags to PlantUML style directives, while version metadata injection outputs library version information as a PlantUML note or table.
The library supports a range of diagram types including system context, container, component, deployment, dynamic, and C4-styled sequence diagrams. It offers controls for element display customization, such as hiding stereotypes, showing element type labels, overriding shapes with standard PlantUML types, and customizing person element appearance. Layout direction can be set to top-to-bottom, left-to-right, or landscape orientation, and legends can be placed as floating elements for compact layout. A sketch mode applies a hand-drawn visual style to indicate draft or work-in-progress designs, with customizable background color, font, warning color, and footer text. Additional capabilities include element property annotation for attaching multi-column property tables, custom sprites and icons, and version information display.
Features
- C4 Architecture Diagrams - Implements the C4 model for creating system context, container, component, and deployment diagrams.
- Container Diagrams - Ships macros for generating container-level C4 diagrams that visualize applications and data stores.
- System Context Diagrams - Provides macros for generating C4 system context diagrams that show system boundaries and external interactions.
- Component Diagrams - Provides macros for creating component-level C4 diagrams that decompose containers into internal parts.
- C4 Diagram as Code - Generates C4 architecture diagrams from PlantUML source text using a diagram-as-code approach.
- C4 Model Documentation - Enables documenting software architecture through C4 model diagrams generated from PlantUML source.
- Macro-Based Diagram Generators - Ships reusable PlantUML macros that expand into complete C4 diagram elements and relationships at render time.
- PlantUML C4 Extensions - Extends PlantUML with C4 model macros for architectural diagramming.
- Diagram Element Nesting - Provides hierarchical nesting of elements within boundaries to build system context, container, and component diagrams.
- Diagram Layout Orientations - Sets the overall reading direction of the diagram to top-to-bottom, left-to-right, or landscape orientation.
- Directional Flow Controllers - Controls the directional flow of diagram elements using PlantUML skinparam and rankdir directives.
- Diagram Annotations - Attaches multi-column property tables to any element or relationship for additional documentation.
- C4 Sequence Diagram Integrations - Integrates C4 element macros into PlantUML sequence diagram syntax for time-ordered message flows.
- C4-Styled - Integrates C4 elements into PlantUML sequence diagrams for time-ordered architecture message flows.
- Dynamic Diagrams - Supports creating dynamic C4 diagrams that model interaction sequences between system elements.
- Diagram Notation Legends - Embeds a color-coded legend inside the drawing canvas to explain element types and relationship styles.
- C4 Sequence Diagrams - Models time-ordered message flows between participants using C4-styled sequence diagrams.
- Diagram Customization - Provides extensive customization options for C4 diagrams including legends, styles, and element properties.
- Deployment Diagrams - Provides macros for creating C4 deployment diagrams that map containers to infrastructure nodes.
- Diagram Tag-Driven Styling - Applies custom colors, line styles, and shapes by mapping user-defined tags to PlantUML style directives.
- Sketch-Style Rendering - Applies a hand-drawn visual style to diagrams to indicate draft or work-in-progress designs.
- Tag-Driven Diagram Styling - Implements tag-driven styling that maps user-defined tags to custom colors, shapes, and line styles.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
