Giter Club home page Giter Club logo

plantuml-c4's Introduction

PlantUML template for C4 diagrams

Taking inspiration from the PlantUML C4 templates by Ricardo Niepel, this C4 PlantUML template includes styling similar to that used by the C4 samples and Structurizr, and maintains a close relationship to the PlantUML core syntax.

Key features

  • C4 and Structurizr styling
  • Complementary C4 helpers, build on top of standard PlantUML relationships
  • A single include file - simple to reference or modify

Getting started

Include the line below at the beginning of your PlantUML file, under the @startuml directive:

!include https://raw.githubusercontent.com/robbell/plantuml-c4/v1.4/c4.puml

Example

@startuml Sample Context diagram 
!include https://raw.githubusercontent.com/robbell/plantuml-c4/v1.4/c4.puml

Person("Clinic employee", "An employee of the clinic") as clinicEmployee
System("Pet Clinic Application", "System for managing vet appointments") as petClinicSystem
clinicEmployee ..> petClinicSystem : Uses

@enduml

Sample Component diagram

Source: samples/pet-clinic-sample.puml

Sample Component diagram

Sample entity usage

Source: samples/entities-sample.puml

Sample entity usage

Related

To add PlantUML diagram generation to your build pipelines, take a look at my PlantUML in Docker project.

To do

  • Style toggling to core PlantUML
  • Key toggling
  • Continued refactoring
  • Additional functions for remaining Context entities, and all other entities at the Container and Component level
  • Update current implementations to more closely resemble vanilla PlantUML syntax
  • Relationship directions
  • Layout helpers using -[hidden]->

plantuml-c4's People

Contributors

asos-robbell avatar robbell avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

plantuml-c4's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.