Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend TOC with links to other files too #264

Merged
merged 3 commits into from
Nov 21, 2022
Merged

Extend TOC with links to other files too #264

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c027f92
Update all deployed *.md files that they can be accessed via https://…
kirchsth Nov 18, 2022
025ad5f
Update all deployed *.md files that they can be accessed via https://…
kirchsth Nov 18, 2022
6fc0aef
Update all deployed *.md files that they can be accessed via https://…
kirchsth Nov 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion LayoutOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

C4-PlantUML comes with some layout options.

- [Layout Options](#layout-options)
- [:page_facing_up: C4-PlantUML](README.md#c4-plantuml)
- [:page_facing_up: Layout Options](#layout-options)
- [Layout Guidance and Practices](#layout-guidance-and-practices)
- [Overall Guidance](#overall-guidance)
- [Layout Practices](#layout-practices)
Expand All @@ -17,6 +18,8 @@ C4-PlantUML comes with some layout options.
- [Using SHOW_PERSON_SPRITE(sprite)](#using-show_person_spritesprite)
- [Using SHOW_PERSON_PORTRAIT()](#using-show_person_portrait)
- [Using SHOW_PERSON_OUTLINE()](#using-show_person_outline)
- samples
- [:page_facing_up: Core Diagrams](samples/C4CoreDiagrams.md#c4-model-diagrams)

## Layout Guidance and Practices

Expand Down Expand Up @@ -161,6 +164,7 @@ Rel(web_app, twitter, "Gets tweets from", "HTTPS")
Instead of a static legend (activated with `LAYOUT_WITH_LEGEND()`) a calculated legend can be activated with `SHOW_LEGEND(?hideStereotype, ?details)`.

The calculated legend has following differences:

- only relevant elements are listed
- custom tags/styles are supported
- stereotypes can remain visible (with `SHOW_LEGEND(false)`)
Expand Down
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ C4-PlantUML combines the benefits of [PlantUML](https://plantuml.com/) and the [

C4-PlantUML includes macros, stereotypes, and other goodies (like VSCode Snippets) for creating C4 diagrams with PlantUML.

- [C4-PlantUML](#c4-plantuml)
- [:page_facing_up: C4-PlantUML](#c4-plantuml)
- [Getting Started](#getting-started)
- [Including the C4-PlantUML library](#including-the-c4-plantuml-library)
- [Now let's create a C4 Container diagram](#now-lets-create-a-c4-container-diagram)
Expand Down Expand Up @@ -53,6 +53,9 @@ C4-PlantUML includes macros, stereotypes, and other goodies (like VSCode Snippet
- [Message Bus and Microservices](#message-bus-and-microservices)
- [Background](#background)
- [License](#license)
- [:page_facing_up: Layout Options](LayoutOptions.md#layout-options)
- samples
- [:page_facing_up: Core Diagrams](samples/C4CoreDiagrams.md#c4-model-diagrams)

## Getting Started

Expand Down
19 changes: 15 additions & 4 deletions samples/C4CoreDiagrams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

The following samples are reproductions with C4-PlantUML from [C4 model core diagrams](https://c4model.com/#coreDiagrams) created by [Simon Brown](https://simonbrown.je/).

- [:page_facing_up: C4-PlantUML](../README.md#c4-plantuml)
- [:page_facing_up: Layout Options](../LayoutOptions.md#layout-options)
- samples
- [:page_facing_up: C4 Model Diagrams](#c4-model-diagrams)
- [Core Diagrams](#core-diagrams)
- [System Context Diagram](#system-context-diagram)
- [Container Diagram](#container-diagram)
- [Component Diagram](#component-diagram)
- [Supplementary Diagrams](#supplementary-diagrams)
- [System Landscape Diagram](#system-landscape-diagram)
- [Dynamic Diagram](#dynamic-diagram)
- [Deployment Diagram](#deployment-diagram)
- [Styles](#styles)
- [Icons](#icons)

## Core Diagrams

### System Context Diagram
Expand All @@ -10,22 +25,18 @@ Source: [C4_Context Diagram Sample - bigbankplc.puml](C4_Context%20Diagram%20Sam

![System Context diagram for Internet Banking System](https://www.plantuml.com/plantuml/png/VL9DRnen4BtlhvXoAP48N7hgAGbTjP4WHGKKzRIQzGvWuRMHFGxmxplx6MXeR-lnUs_UUzw7mEWvbYRvfAqoiI3OCH_2ryd4ut6yrRoBUGpabRDCbiVAbHCil4RxPk8XJgPVxXS6BQ_diub1fi0oogOL-iJZGwNy6Q8LMYbqu1t1nXdZZjfkmMXBWBQ0gsljWtmvaBLWd49ZpgBH-_jRFfaz_lwvNcMlpwiVsIpzdhvy6zub2Mis1CjpO2gX9K2XSUkn50iUdcNaBJ4yeTrNRXfiaYp81sU7AWPs9VaH39e9cXuwRUy6Sla87HBSfawG2se4H-aE3XspcW4gvQBbC1xS9SssOTuePg4-Yjm_RDMRgjv2lovK9RrfEeAs4gX4riu2vYxMHMf_lNHKDrtYdk20vwhksaTh94jFF2nHctSdwNrrXj3lNqasNTkJG7Ejl0jkmv2Ur0xjbe0k2UyPEscxaUf9TERTzusCItQU0iYZTsqg6K1RqusaVHkZYwJiqGPK5KnEnAfE-elCnQj-Q7uTA0XCKDaJglq5zBgN9TaYj66hDsWvBwItkzpv3q_w7tQTUBvQD1Atc7rfhRi7eSjV_mS0 "System Context diagram for Internet Banking System")


### Container Diagram

Source: [C4_Container Diagram Sample - bigbankplc.puml](C4_Container%20Diagram%20Sample%20-%20bigbankplc.puml)

![Container diagram for Internet Banking System](https://www.plantuml.com/plantuml/png/bLLDZzis4BtxLqoTGnr0kqQ0ddgArpQwcwntrSZRJK_2Y1hRH2XI82axHj7_tg6i3yiEajGdQJJpvl7D6_gzysXzLQZHBr8BLUK4E-zBz_jqQl5mkvL-LsML8okCzgJzhJ3557ChKUzLLLRJ-MytiKBjNrQFKuMUdETGEkTib9hiRHcmVuLASs710E1t11kZb3b8lGN5IO0wXy5dQHq_6U36e8n0fOwCqJ6yRi1V7sT_Fx-iq_Lpd2wUNvycR_lOB4cJZylr_9w3JUZrONsVFYx_M3ujE3ZoqYl6RK4XbxYrM31H2mzySAl9mntgBu5pSdIUYj4e9kkCdeZAULEGZM3UFOrdq8R1REf3PLmTmO45XR8kH5N708KmbVPkp3nEqEaT1tAqnubunrYN1CPluPyHyA_ZEpbGbc9PSl8hPJ0hIoK5Ucdqc4CVS8yH9AKDv5T_pKDiGKhkcKPDZJtWfO1cnFKuGhZhcxK7ZsTCSjZPbOmzJlYpefiOjnIwjrqJOMNf8vZfRQNGXd1ipLxcv827-kqk6_PAe8vA-cDmWQXg8Hti9OOIQO7F2var1pRc5QF2P59H8yUgVcavpTz4y1aBP2M6NDY7XVIKWwionroQcVqCDtT5xaG0SjfBGPVq5jaaHuyPEWfZQ1u3c-JFHnYyUsEPMrW-iBILpblarY0rkxAefnl1ZfDpm8fT9IpbF3w9oaN1LEGSBy-MNyYBsokPCXHVIEUiamn-ZH--RPk5uJJRrmrq-u4-GH86vjR_TjPUVlKJAb2grDK1XblUhFYzMQk0lsRfPGtDExAImXfdDXwMNyKEDJliLCcmPvWDWnwLCVM6TvWkzlPCsc31PjA20zqfpXG6p4pb-p57tRf6mFFG3klpzYAFFf4wknBwnNnnv4Bl-_KwJZXnc7TQe-_d38nTfvxQfKyajxlCd5q39xXsoHkaEZWSUziGtL6B23uapq_Jy-RdBVzNPNh7sJsntl93b4-4kOEDDKLzwnmiBo7VIIOWDy2Bktbxpe1vfiU5ZHA6TK0t8LfZz4Gk73VaCAohNBXXk_R9QXqtGDrX1kLNlck52VNJHftF_EVOYlEUI_alwpy0 "Container diagram for Internet Banking System")


### Component Diagram

Source: [C4_Component Diagram Sample - bigbankplc.puml](C4_Component%20Diagram%20Sample%20-%20bigbankplc.puml)


![Component diagram for Internet Banking System - API Application](https://www.plantuml.com/plantuml/png/fLN9Rjim4BthAwO-j3QGn9UUUggNj4cGnOYTBYTZHD4oMou25xj6qN_laB8bsGcA0Cqbr73uvisRH_gZysXzK39x8pIJeU2mzhvo7uP3YzkBKlXro8FZbXdjkVONpAWX5bQWtiXGXU7a_VbCelPFTxT3YPuxJw7bnAZAw9XVHUnt43GTL1G0l-QmCbAQhT0bIA4ve2xWQ5jOHoi3L1YaOIZbZZ0QXiyBPBUZxmzFY-NNwyNLylRoy-Nzj3_8CY-yfFH3BXG2IukAwbkufdwivXx6g7z6AlETyrp1EOncrp2gAYaOUc5qbaseToIYjkygF8FUdD89TuObxoRsQEi7Rj0nAogVka9T1easxioisOY2Ew1kKfVYG23V4rYHI147fV2xs3uBpXl5hOEDm7X6MDZo779hjZIIYzwWGqr5PdSc5pAHYYM_eK8hz75rabm9pmjm8NTKtVZ_OAFgUlj_1Ty8nezeJVD-aLFzANhCqV78vP5Bh97X48OvMtE5SNVkZIMUqNDWUIcSjocR6DBOL5gVmHhTcdh0G3oqtmy0cEL5_4JfpW0PuywHVqhwu9v5NlMCbvU_V5_bBWf6B5Ta2NvYWmwJE2-pIY8n2ZG2TVW0vYRuLg5Kt0JjQKNqjSCaPSkZ5MWvfhm2xQwFbQ2Y9-Rh3U1t1lJNcBZlHAcJ2KjD9eQ8PEa-yUIokoyJUAHBs8PZT1IlMwsfYwEC4CG_Bb-SlQir69nKRflgZVPBc0T59jkzYaPZmjPAMtfWo9EEK0oXr3gJiIAJHiHdH1ndmP8jempxPRkRHbVPsCUOux7xZqrjen79HKaHNTP3FGEsnlgZGkUsnXRjt8vfa8LMoB3W_p0IV4ePBv0QGNqOIA9w3gh1E1v4SamiJJTdF_wE0a-E7nIA--sGklHEajhZwNO-SYpWBMmfn4cDoEvcEfvq3dImwekJ0ECRG-_-rM8ncrFodonBuF6HtBlqa7OpVxXlyfgaZg5UJ4oPwXLewXLW7xakwBVYBm00 "Component diagram for Internet Banking System - API Application")


## Supplementary Diagrams

### System Landscape Diagram
Expand Down