https://github.com/future-architect/puml-themes
PlantUML thema
https://github.com/future-architect/puml-themes
Last synced: 5 months ago
JSON representation
PlantUML thema
- Host: GitHub
- URL: https://github.com/future-architect/puml-themes
- Owner: future-architect
- License: apache-2.0
- Created: 2020-08-18T08:31:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-08T01:32:48.000Z (over 4 years ago)
- Last Synced: 2025-05-07T21:09:00.619Z (about 1 year ago)
- Size: 197 KB
- Stars: 61
- Watchers: 13
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puml-themes
PlantUML themes for all developers.
## Abstract
These themes were created as part of a standardization effort to help design teams mass-produce business functions' processing flows. It is mainly intended for use in sequence diagrams.
For more details, please check [here(日本語)](https://future-architect.github.io/articles/20200203/). (available in Japanese only)
## Usage
Write `!include ` between @startuml and @enduml block.
### Example of 'toy' theme
```
@startuml
!include https://raw.githubusercontent.com/future-architect/puml-themes/master/themes/puml-theme-toy.puml
participant Participant as Foo
note over Foo: Event
actor Actor as Foo1
boundary Boundary as Foo2
control Control as Foo3
entity Entity as Foo4
database Database as Foo5
collections Collections as Foo6
queue Queue as Foo7
Foo -> Foo1 : To actor
Foo -> Foo2 : To boundary
Foo -> Foo3 : To control
Foo -> Foo4 : To entity
Foo -> Foo5 : To database
Foo -> Foo6 : To collections
Foo -> Foo7: To queue
@enduml
```
Output is bellow.
### Example of 'vibrant' theme
```
@startuml
!include https://raw.githubusercontent.com/future-architect/puml-themes/master/themes/puml-theme-vibrant.puml
participant Participant as Foo
note over Foo: Event
actor Actor as Foo1
boundary Boundary as Foo2
control Control as Foo3
entity Entity as Foo4
database Database as Foo5
collections Collections as Foo6
queue Queue as Foo7
Foo -> Foo1 : To actor
Foo -> Foo2 : To boundary
Foo -> Foo3 : To control
Foo -> Foo4 : To entity
Foo -> Foo5 : To database
Foo -> Foo6 : To collections
Foo -> Foo7: To queue
@enduml
```
Output is bellow.
### Example of 'mars' theme
```
@startuml
!include https://raw.githubusercontent.com/future-architect/puml-themes/master/themes/puml-theme-mars.puml
participant Participant as Foo
note over Foo: Event
actor Actor as Foo1
boundary Boundary as Foo2
control Control as Foo3
entity Entity as Foo4
database Database as Foo5
collections Collections as Foo6
queue Queue as Foo7
Foo -> Foo1 : To actor
Foo -> Foo2 : To boundary
Foo -> Foo3 : To control
Foo -> Foo4 : To entity
Foo -> Foo5 : To database
Foo -> Foo6 : To collections
Foo -> Foo7: To queue
@enduml
```
Output is bellow.
All the themes above are also available in the official PlantUML theme library.
However, all future updates and themes will be reflected in this repository first.
## License
This version of puml-themes is released under the Apache License, Version 2.0 (see [LICENSE](https://github.com/future-architect/puml-themes/blob/master/LICENSE)).