Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skleanthous/C4-PlantumlSkin
This library provides skinning to create C4 diagrams using PlantUml
https://github.com/skleanthous/C4-PlantumlSkin
architecture architecture-diagram architecture-doc architecture-visualization c4model diagram plantuml uml uml-diagrams
Last synced: about 2 months ago
JSON representation
This library provides skinning to create C4 diagrams using PlantUml
- Host: GitHub
- URL: https://github.com/skleanthous/C4-PlantumlSkin
- Owner: skleanthous
- License: mit
- Created: 2019-03-08T10:53:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-06T09:47:55.000Z (about 4 years ago)
- Last Synced: 2024-08-02T16:47:51.145Z (5 months ago)
- Topics: architecture, architecture-diagram, architecture-doc, architecture-visualization, c4model, diagram, plantuml, uml, uml-diagrams
- Language: Shell
- Homepage:
- Size: 426 KB
- Stars: 76
- Watchers: 6
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# C4-PlantumlSkin
A skin with related guidance for generating [C4](https://c4model.com) diagrams using the [Plantuml](https://plantuml.com) and related tools.
## Prerequisites
---
Before you start, you need to be familiar at minimum with:
- [PlantUML](http://plantuml.com/index)
- [C4 model](https://c4model.com/)
First of all you need to have a Plantuml editor up and running. For this you have multiple options (all of which will work with this):
1. [Local installation](http://plantuml.com/starting)
1. [Free online editor (PlantText)](https://www.planttext.com/?text=5Osn3SCm30HxJv4C4B5nbSf05WYG2MI9i0XJb22ISCQFyjrTSR-fnM5UURcJ9FQCFlXMpBe-0KQyma5MV7V5aPeOYeNKAkZ96CLASuNN-dZpX5dvd2HGeneEs9quGtFhRf3MqFylaRbTbRuanpAteUIfVm00) <-- Online template ready for you to get started creating C4 models right now!!
1. [Free online editor from PlantUML](http://www.plantuml.com/plantuml/uml/5Oqn3W8X44LxJw47a6csijh42vXu0XOcGdOO2FCdNb-iNbxptcw84zxaSgkQn3Fxb6i1XZs8Plo6JqNnmurdwWfMXDGRsIaS5QMxqNExlsJ9ghpFgjIYWISTNYLJTmm7fIsC_sLdpOi_) <-- Another template, a click away, ready for you to get started creating C4 models right now!!
1. [VisualStudio Code Plugin](https://github.com/qjebbs/vscode-plantuml): This plugin allows you to "embed" diagrams in your markdown files, which is the best of all worlds in my opinion, and hence really recommended.
Once you have something running (or just went to PlantText online editor), you can start using Plantuml to create text-driven models and diagrams.
## Quickstart
---
Assuming that you have an environment that you can use Plantuml, add the following line:
```plantumlcode
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
```
Just below `@startuml`, and then use the following components with the specified stereotype:
| C4 artifact | PlantUml | Stereotype for internal | Stereotype for external |
|---|---|---|---|
| Person | `actor` | `<>` | `<>` |
| System | `frame` | `<>`,
`<>`,
or `<>` | `<>`
or `<>` |
| System | `rectangle` | `<>`
or `<>` | `<>` |
| Containers | `component` | `<>`,
`<>`,
or `<>` | `<>`
or `<>` |
| Containers | `rectangle` | `<>`
or `<>` | `<>` |
| Component | `rectangle` | `<>`
or `<>` | `<>` |
| Database | `database` | `<>`
or `<>` | `<>`
or `<>` |
| Queue | `queue` | `<>`
or `<>` | `<>`
or `<>` |
| Expanded systems,
containers and components | `frame`,
`component`,
or `rectangle`
according to your need | `` | `` |
## Examples
---
Reproduced (as closely as possible from diagrams from [the official C4 model website](https://c4model.com/))
1. System Context diagram
[Plantuml file for diagram below](./sample/c4-banking-system.puml)
[Edit this diagram online!](http://www.plantuml.com/plantuml/uml/jP8_Rzim4CLtVefhHgEH5az1OAGDF6G8423PcY0uKsUBCFy8l6FjeEXtxrcIvTG1sYuLj8ZwlSVtUBnXmImbUFF9HUjBGoLxQ4KwlghhZBjguwGjgyAKROf2KIgRGirRJnYbJONhs_dbWyTuS7dSkbW7PA5ShuhpJPsAT4LgEw-wmov6d7Y2hnYLt02_AHgCnKvSYl3KEWPzfJqXZpq2jCVGgL9mIn7MEOKffPs7r93lSvbCLZ1kbAI0ph_o8B--NkurL4G_6YuMyCs0FhFPyl90ZbbcCzClFsa45mV5lRCvSLeBBFUsLNVg4NglCo_QBMr8esVuqVz7Aod3nGDbJcepDNgEjuKb1SeNckikZha6JdCXWns18Skfa-jXajVLu3NfF_OQkjsDWhFZr9OJzCNxj3jjoI09lZlQJO2BwvG3zXF2LIe2Mj9bE6JuF55eRIfH630s47HAqE5R85tfaPVpAW7LDsEWKnUTqP-wt1yL_wlCltVvQSnn2wYQj8lLukDihg0miJbVdmJJ2VnTaTsc5PMylzDACyLcl8Ry70ihQynlJAMYOz8p0KWoD_fTWly5)
2. Container diagram
[Plantuml file for diagram below](./sample/c4-banking-container.puml)
[Edit this diagram online](http://www.plantuml.com/plantuml/uml/bPDHQzim4CVVzIcq3n3xfK-bcD9sq9Lr2qq6WoQKYtsDHQMJa4waO-oxx-mQrtDeMKiVWlZzzB__HJbF396pi-gJeThc1dEqkcKEwRGi8noAlU4sxtB2M7jY92vgxyhqP168MvzJUNcoM5gWxfRLaw7IGMACvIuRsvG-SyXSrYT5w58K6xQeBu24tElqIr2dQWXiFEbrQvAMVsvVaKj91KCODJw32o8pF27fn-ZTE6Xzudo3jXzDAQZPHrtdnDw9TtRsXHWZWTLBZCbJLIbrXpK3xUKw1uOU8pXyU9b6-C_F0x_gJuH_nL5u-nwguiYQFXU97tP3cqu8G0qsLQL_Aor_CdFm7QGFk7k04AofeL_7PF1n2rKrarBukEFypbZy7wyN6s3OGSBnmvI-6iwEGY2OjsxzezIyw-A-DKs3j8rct_AYclLIARoF7rTwEwBn1rfKOnkbngTI59MUQwVwHy8DtLypXxJzbqtX64rJP3hO75FTXeg-W73pPpXG4lppzklcUhrUhhOlXiL74SRn1Rn3Q5B_YzWGKACFqJ0cpLxicwkBo-sGbODuqmSixWf5wCysb9EXlJYhs_LogwRWu8xDffwQVpb5js2X9VErnStg-xTog37kv0FEkUHbP_y2)
3. Component diagram
## _**!!!TODO!!!**_
## Brief description
---
This project will help you use the awesome Plantuml tooling to create C4 diagrams for documenting architecture.
C4 defines a set of diagrams (core and supplementary) that are designed to document architecture in a way that is easy to understand and communicate.
Plantuml is a uniquely pleasant-to-use tool to create diagrams from text. The fact that this is a text-driven tool opens up a lot of previously impossible scenarios:
1. It is a *pleasure* to edit
1. You don't need special tooling
1. You can keep your domain models side-by-side with your code
1. You can embed models in your markdown documents in almost all major editors
1. Did I mention that it is an absolute pleasure to work with Plantuml?
The only real disadvantage is that positioning can sometimes be [a bit tricky](https://stackoverflow.com/a/48735216).
This skin allows you to use stereotypes to skin your diagram to be close to what is standard with C4. You can use the `!includeurl` to skin the following diagrams:
1. System Context diagram
1. Container diagram
1. Component diagram
1. System Landscape diagram
1. Dynamic diagram
## Instructions
---
All that is needed to start is to add the following line:
```plantumlcode
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
```
> **NOTE**: The skin sets your diagram type as a Plantuml _deployment diagram_. If you want to add some incompatible artifacts in your diagram, you'll need to add the following statement after the `!includeurl`
> ```plantumlcode
> allowmixing
> ```
1. ### Stereotypes and Legend
As mentioned above, the way the artifacts get C4 styling is through the use of Plantuml `<>`. Currently stereotype names are not emitted; instead, a legend is emited at the bottom right. To turn it off, add `!define NO_LEGEND` before the import, like in [this example](https://www.planttext.com/?text=TP91JyCm38Nl-HNU2JXqkUo4gWc93JG9ZOaT4K9fuhNHKcTA70R_dcwexQQMtEBt_DbFoKDa5JZLJamCxYmXh5y_NvRFo_L2Y8abxPB151nKp8TuBsLGnsbfkKf5YXYq9qRYgVQrZ7k7YhZoASh7MRPnpQK1R_UMPAqYOv15iiv8d_YGMEhPz70QB09gLbGwX5L32wJSMrV9yxO6sv-6KS_d5_xbzz3Vrdg_s0LLz_2dyotFE_rFRljQUOHZJuITqZrhrLKkUBsjPLpQHhZ3s905MrQSpM6OKLm7EP-X_IoAuPuZrauKuWOsFbgsdYoLK3L98jmQVoJGYg10K4KHyCigHWFiOG78-cuaGFPUMMEGFaxDpR2hdKSI_EVlTxj-dx6UOPu79DDyiLy0).
2. ### Represent C4 Person --> with Plantuml Actors
There is support for two types of actors: Internal and external. The supported stereotypes are:
- `<>`
- `<>`
The following code:
```plantumlcode
@startuml
!define NO_LEGEND
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
actor Internal <>
actor External <>
actor InternalPerson <>
actor ExternalPerson <>
External -down-> Internal
Internal -right-> InternalPerson
InternalPerson -up-> ExternalPerson
@enduml
```
Produces this outcome:
3. #### Represent C4 Systems --> with Plantuml Rectangles and Frames
C4 Systems can be represented using Plantuml `rectangle`s and `frame`s. In both cases the stereotypes that could be used are:
> **NOTE**: the simplicity of rectangles makes them really useful if you want to avoid the connotations implied by UML artifacts, so they are used to represent other C4 artifacts too
- `<>`
- `<>` (an alias to `<>`)
- `<>`
The following code:
```plantumlcode
@startuml
!define NO_LEGEND
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
rectangle InternalRectangle <>
rectangle ExternalRectangle <>
frame InternalFrame <>
frame ExternalFrame <>
interface InternalInterface <>
interface ExternalInterface <>
InternalRectangle -right-> ExternalRectangle
InternalFrame -right-> ExternalFrame
InternalInterface -right-> ExternalInterface
' Positioning hints (down can be abbreviated to D etc)
InternalRectangle -[hidden]down-> InternalFrame
InternalFrame -[hidden]down-> InternalInterface
ExternalFrame -[hidden]down-> ExternalInterface
@enduml
```
Produces the outcome:
4. #### Represent C4 Containers --> with PlantUml Rectangle and Components
C4 containers can be represented by using plantuml rectangles (and not C4 components which is a bit confusing), which are useful to be shown normally on `System Context`, `Container` and `System Landscape` diagrams. The supported stereotypes are:
- `<>`
- `<>` (an alias to `Internal Container`)
- `<>`
The following code:
```plantumlcode
@startuml
!define NO_LEGEND
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
component InternalComponent <>
component ExternalComponent <>
rectangle InternalRectangle <>
rectangle ExternalRectangle <>
interface InternalInterface <>
interface ExternalInterface <>
InternalComponent -right-> ExternalComponent
InternalRectangle -right-> ExternalRectangle
InternalInterface --right-> ExternalInterface
' Position hints (down can be abbreviated to D etc)
InternalComponent -[hidden]down-> InternalRectangle
InternalRectangle -[hidden]down-> InternalInterface
ExternalRectangle -[hidden]down-> ExternalInterface
@enduml
```
Produces this outcome:
5. #### Represent C4 components --> with Plantuml rectangles
C4 components can currently only be represented by Plantuml rectangles. The are only really useful in Component C4 diagrams, but obviously really important. The stereotypes used are:
- `<>`
- `<>` (an alias to `<>`)
- `<>`
The following code:
```plantumlcode
@startuml
!define NO_LEGEND
!includeurl https://raw.githubusercontent.com/skleanthous/C4-PlantumlSkin/master/build/output/c4.puml
rectangle Internal <>
rectangle External <>
interface Internal <> as IInternal
interface External <> as IExternal
Internal -right-> External
IInternal -right-> IExternal
'Positioning hints
Internal -[hidden]down-> IInternal
External -[hidden]down-> IExternal
@enduml
```
Produces this outcome:
6. #### More details
The above should be enough to get you started. For more info please see:
- [Items definitions](./src/items)
- [PlantUml files for the sample diagrams](./sample/)
- [List of all supported artifacts](./docs/diagrams/)
- [Canonical SO answer re layout black magic](https://stackoverflow.com/a/48735216)
## work outstanding
1. Complete examples
1. Add skinning for C4 Code diagrams
## Updates
- [2019-04-12] : Added skinning for sequence diagrams. Add `!define SKIN_SEQUENCE_DIAGRAM` before the include statement. See [a short sample](./sample/sequence.puml)
- [2019-03-29] : Added skinning to cloud. Either define "SKIN_CLOUD" or use `<>` stereotype
- [2019-03-28] : Added support to skin interfaces in systems, containers and components.
- [2019-03-28] : Fixed bug in legend titles
- [Initial release] : Skinning support for internal and external, systems, container, components and users. Includes skinning for databases and queues. Also, provides support for expanded items (see [container diagram](#container-diagram) for an expanded system)
## Inspiration / Acknowledgements
---
One major acknowledgment is [C4-PlantUML](https://github.com/RicardoNiepel/C4-PlantUML) from [Ricardo Niepel](https://github.com/RicardoNiepel). This is a very good library to work with C4, but I wanted something much more native to Plantuml. Specifically I wanted to be able to work with Plantuml native primitives (`rectangle`, `queue`, `component`, etc.) instead of the "method"-like means that this library exposes.
Obviously a huge thank you to the awesome teams at [PlantUML](https://plantuml.com).
Finally, to [Simon Brown](https://github.com/simonbrowndotje) for originating the [C4 model](https://c4model.com).