Alawn/C4-PlantUML
1
0
Fork 0
mirror of https://github.com/plantuml-stdlib/C4-PlantUML.git synced 2022-10-18 01:14:54 +00:00
Code Issues Projects Releases Wiki Activity

switched urls to https://github.com/plantuml-stdlib/C4-PlantUML

Browse Source
This commit is contained in:
Adrian Lupu
2020-11-21 21:33:30 +02:00
parent 5c21e88177
commit 7d050e48b0
19 changed files with 34 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.vscode/C4.code-snippets
Vendored
+5 -5
View File
@@ -3,7 +3,7 @@
"scope": "plantuml",
"prefix": "Include C4 Context Diagram",
"body": [
"!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml"
"!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml"
],
"description": "Include C4 Context Diagram"
},
@@ -11,7 +11,7 @@
"scope": "plantuml",
"prefix": "Include C4 Container Diagram",
"body": [
"!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml"
"!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml"
],
"description": "Include C4 Container Diagram"
},
@@ -19,7 +19,7 @@
"scope": "plantuml",
"prefix": "Include C4 Component Diagram",
"body": [
"!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Component.puml"
"!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml"
],
"description": "Include C4 Component Diagram"
},
@@ -27,7 +27,7 @@
"scope": "plantuml",
"prefix": "Include C4 Deployment Diagram",
"body": [
"!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Deployment.puml"
"!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml"
],
"description": "Include C4 Deployment Diagram"
},
@@ -35,7 +35,7 @@
"scope": "plantuml",
"prefix": "Include C4 Dynamic Diagram",
"body": [
"!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Dynamic.puml"
"!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml"
],
"description": "Include C4 Dynamic Diagram"
},
C4_Component.puml
+1 -1
View File
@@ -1,4 +1,4 @@
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
C4_Container.puml
+1 -1
View File
@@ -1,4 +1,4 @@
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
' uncomment the following line and comment the first to use locally
' !include C4_Context.puml
C4_Context.puml
+1 -1
View File
@@ -1,4 +1,4 @@
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4.puml
' uncomment the following line and comment the first to use locally
' !include C4.puml
C4_Deployment.puml
+1 -1
View File
@@ -1,4 +1,4 @@
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
C4_Dynamic.puml
+1 -1
View File
@@ -1,4 +1,4 @@
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Component.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
' uncomment the following line and comment the first to use locally
' !include C4_Component.puml
LayoutOptions.md
+5 -5
View File
@@ -12,7 +12,7 @@ With the two macros `LAYOUT_TOP_DOWN()` and `LAYOUT_LEFT_RIGHT()` it is possible
```csharp
@startuml LAYOUT_TOP_DOWN Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
/' Not needed because this is the default '/
LAYOUT_TOP_DOWN()
@@ -35,7 +35,7 @@ Using `LAYOUT_LEFT_RIGHT()`
```csharp
@startuml LAYOUT_LEFT_RIGHT Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
LAYOUT_LEFT_RIGHT()
@@ -63,7 +63,7 @@ This can be enabled with `LAYOUT_WITH_LEGEND()`.
```csharp
@startuml LAYOUT_WITH_LEGEND Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
LAYOUT_WITH_LEGEND()
@@ -97,7 +97,7 @@ With `LAYOUT_AS_SKETCH()` you can make a difference.
```csharp
@startuml LAYOUT_AS_SKETCH Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
LAYOUT_AS_SKETCH()
@@ -122,7 +122,7 @@ This can be enabled with `HIDE_STEREOTYPE()`.
```csharp
@startuml HIDE_STEREOTYPE Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
HIDE_STEREOTYPE()
README.md
+8 -8
View File
@@ -32,7 +32,7 @@ Just remember to change the `!include` statements at the top of the files.
If you want to use the always up-to-date version in this repo, use the following:
```c#
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
```
Now let's create a C4 Container diagram:
@@ -41,7 +41,7 @@ After you have included `C4_Container.puml` you can use the defined macro defini
```csharp
@startuml C4_Elements
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
Person(personAlias, "Label", "Optional Description")
Container(containerAlias, "Label", "Technology", "Optional Description")
@@ -59,7 +59,7 @@ Take a look a look at the following sample of a C4 Container Diagram:
```csharp
@startuml Basic Sample
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
Person(admin, "Administrator")
System_Boundary(c1, "Sample System") {
@@ -78,7 +78,7 @@ Entities can also be decorated with icons using the last parameter, for example:
```cs
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
@@ -108,7 +108,7 @@ Rel_R(api, db, "Reads/Writes")
## Supported Diagram Types
* System Context & System Landscape diagrams
* Import: `!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml`
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml`
* Macros:
* `Person`
* `Person_Ext`
@@ -128,7 +128,7 @@ Rel_R(api, db, "Reads/Writes")
* `ContainerQueue_Ext`
* `Container_Boundary`
* Component diagram
* Import: `!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Component.puml`
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml`
* Additional Macros:
* `Component`
* `ComponentDb`
@@ -137,13 +137,13 @@ Rel_R(api, db, "Reads/Writes")
* `ComponentDb_Ext`
* `ComponentQueue_Ext`
* Dynamic diagram
* Import: `!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Dynamic.puml`
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml`
* Additional Macros:
* `RelIndex`
* `increment`
* `setIndex`
* Deployment diagram
* Import: `!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Deployment.puml`
* Import: `!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml`
* Additional Macros:
* `Deployment_Node`
samples/C4_Component Diagram Sample - bigbankplc.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Component.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
' uncomment the following line and comment the first to use locally
' !include C4_Component.puml
samples/C4_Container Diagram Sample - bigbankplc-icons.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons
!define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5
' uncomment the following line and comment the first to use locally
samples/C4_Container Diagram Sample - bigbankplc.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
samples/C4_Container Diagram Sample - message bus.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml "messagebus"
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
samples/C4_Container Diagram Sample - techtribesjs.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml "techtribesjs"
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Container.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
' uncomment the following line and comment the first to use locally
' !include C4_Container.puml
samples/C4_Context Diagram Sample - bigbankplc-landscape.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
' uncomment the following line and comment the first to use locally
' !include C4_Context.puml
samples/C4_Context Diagram Sample - bigbankplc.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
' uncomment the following line and comment the first to use locally
' !include C4_Context.puml
samples/C4_Context Diagram Sample - enterprise.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml "enterprise"
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Context.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
' uncomment the following line and comment the first to use locally
' !include C4_Context.puml
samples/C4_Deployment Diagram Sample - bigbankplc.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Deployment.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Deployment.puml
' uncomment the following line and comment the first to use locally
' !include C4_Deployment.puml
samples/C4_Dynamic Diagram Sample - bigbankplc.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Dynamic.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml
LAYOUT_WITH_LEGEND()
samples/C4_Dynamic Diagram Sample - message bus.puml
+1 -1
View File
@@ -1,5 +1,5 @@
@startuml
!include https://raw.githubusercontent.com/adrianvlupu/C4-PlantUML/latest/C4_Dynamic.puml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Dynamic.puml
LAYOUT_TOP_DOWN()
LAYOUT_WITH_LEGEND()