Markdownファイル内で、PlantUMLの図を挿入することが増えそうなので自分用のチートシートを作成しておくこのにしました。
参考:配置図の構文と機能
自分がよく使いそうな機能
見た目
記述内容
``` plantuml @startuml title 自分がよく使う記述 skinparam backgroundColor #eeeeee scale 800 width artifact アーティファクト { agent サンプルA as A #pink;line:red;line.bold;text:red agent サンプルB as B #line:red;line.bold;text:red } card カード { agent サンプルC as C #skyblue;line:blue;line.bold;text:blue agent サンプルD as D #line:blue;line.bold;text:blue } agent サンプルE as E A -[bold]> B B -[dashed]> C C -[dotted]> D D -[plain]-> E E -[hidden]-> A E ---> A @enduml ```
要素の種類
見た目
記述内容
``` plantuml @startuml title 要素の種類 skinparam backgroundColor #eeeeee scale 800 width interface スタート interface スタート2 interface スタート3 interface スタート4 interface スタート5 interface スタート6 actor アクター actor "アクター/" agent エージェント artifact アーティファクト boundary 境界 card カード circle 円 cloud クラウド collections コレクション component コンポーネント control コントロール database データベース entity エンティティ file ファイル folder フォルダ frame フレーム hexagon 六角形 interface インターフェイス label ラベル node ノード package パッケージ person 人型 queue キュー rectangle 四角形 stack スタック storage ストレージ usecase ユースケース usecase "ユースケース/" スタート -[bold]-> アクター スタート -[dashed]-> "アクター/" スタート -[dotted]-> カード スタート -[hidden]-> 境界 スタート -[plain]-> 円 アクター -[hidden]-> スタート2 "アクター/" -[hidden]-> スタート2 カード --[hidden]> スタート2 境界 -[hidden]-> スタート2 円 -[hidden]-> スタート2 スタート2 -->> クラウド スタート2 --0 コレクション スタート2 --^ コンポーネント スタート2 --(0 コントロール スタート2 --(0 データベース クラウド -[hidden]-> スタート3 コレクション -[hidden]-> スタート3 コンポーネント -[hidden]-> スタート3 コントロール -[hidden]-> スタート3 データベース -[hidden]-> スタート3 スタート3 -0- エンティティ スタート3 -0)- ファイル スタート3 -(0- フォルダ スタート3 -(0)- フレーム スタート3 --> 六角形 エンティティ -[hidden]-> スタート4 ファイル -[hidden]-> スタート4 フォルダ -[hidden]-> スタート4 フレーム -[hidden]-> スタート4 六角形 -[hidden]-> スタート4 スタート4 --> インターフェイス スタート4 --> ラベル スタート4 --> ノード スタート4 --> パッケージ スタート4 --> 人型 インターフェイス -[hidden]-> スタート5 ラベル -[hidden]-> スタート5 ノード -[hidden]-> スタート5 パッケージ -[hidden]-> スタート5 人型 -[hidden]-> スタート5 スタート5 --> キュー スタート5 --> 四角形 スタート5 --> スタック スタート5 --> ストレージ スタート5 --> ユースケース キュー -[hidden]-> スタート6 四角形 -[hidden]-> スタート6 スタック -[hidden]-> スタート6 ストレージ -[hidden]-> スタート6 ユースケース -[hidden]-> スタート6 スタート6 --> エージェント スタート6 --> アーティファクト スタート6 --> "ユースケース/" @enduml ```
リンクの種類
見た目
記述内容
``` plantuml @startuml title リンクの種類 skinparam backgroundColor #eeeeee scale 800 width node foo agent bar1 #pink;line:red;line.bold;text:red agent bar2 agent bar3 agent bar4 agent bar5 foo -[bold]-> bar1 foo -[dashed]-> bar2 foo -[dotted]-> bar3 foo -[hidden]-> bar4 foo -[plain]-> bar5 artifact アーティファクト { artifact アーティファクト2 artifact アーティファクト3 artifact アーティファクト4 artifact アーティファクト5 artifact アーティファクト6 artifact アーティファクト7 artifact アーティファクト8 artifact アーティファクト9 artifact アーティファクト10 bar3 --> アーティファクト2 bar3 --* アーティファクト3 bar3 --o アーティファクト4 bar3 --+ アーティファクト5 bar3 --# アーティファクト6 } アーティファクト4 -->> アーティファクト7 アーティファクト4 --0 アーティファクト8 アーティファクト4 --^ アーティファクト9 アーティファクト4 --(0 アーティファクト10 card カード { card カード2 card カード3 card カード4 card カード5 } アーティファクト8 -0- カード2 アーティファクト8 -0)- カード3 アーティファクト8 -(0- カード4 アーティファクト8 -(0)- カード5 @enduml ```