Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robbell/plantuml-c4
A simple and flexible PlantUML template for creating C4 diagrams
https://github.com/robbell/plantuml-c4
architecture architecture-diagrams c4 c4-diagrams c4model good-first-issue help-wanted logical-architecture plantuml plantuml-c4 plantuml-template structurizr
Last synced: 5 days ago
JSON representation
A simple and flexible PlantUML template for creating C4 diagrams
- Host: GitHub
- URL: https://github.com/robbell/plantuml-c4
- Owner: robbell
- License: mit
- Created: 2020-02-13T23:02:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-29T14:37:52.000Z (almost 4 years ago)
- Last Synced: 2024-08-02T16:44:06.236Z (3 months ago)
- Topics: architecture, architecture-diagrams, c4, c4-diagrams, c4model, good-first-issue, help-wanted, logical-architecture, plantuml, plantuml-c4, plantuml-template, structurizr
- Homepage:
- Size: 43 KB
- Stars: 26
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PlantUML template for C4 diagrams
Taking inspiration from the [PlantUML C4 templates](https://github.com/RicardoNiepel/C4-PlantUML) by Ricardo Niepel, this [C4](https://c4model.com/) [PlantUML](https://plantuml.com/) template includes styling similar to that used by the [C4 samples](https://c4model.com/#CoreDiagrams) and [Structurizr](https://structurizr.com/), 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.pumlPerson("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](samples/pet-clinic-sample.puml)
![Sample Component diagram](samples/pet-clinic-sample.svg)
## Sample entity usage
Source: [samples/entities-sample.puml](samples/entities-sample.puml)
![Sample entity usage](samples/entities-sample.svg)
## Related
To add **PlantUML** diagram generation to your build pipelines, take a look at my [PlantUML in Docker](https://github.com/robbell/plantuml-docker) project.
## To do
- [ ] Style toggling to core PlantUML
- [ ] Key toggling
- [ ] Continued refactoring
- [x] Additional functions for remaining Context entities, and all other entities at the Container and Component level
- [x] Update current implementations to more closely resemble vanilla PlantUML syntax
- [x] Relationship directions
- [x] Layout helpers using -[hidden]->