UNPKG

markdown-it-textual-uml

Version:

Markdown-it markdown parser plugin to create uml diagrams from text, based on plantuml, mermaid, etc.

github.com/manastalukdar/markdown-it-textual-uml

manastalukdar/markdown-it-textual-uml

130 lines (106 loc) • 2.64 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
Simple diagram . ```plantuml Bob -> Alice : hello ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IW80" alt="uml diagram"> . Diagram with alt text . ```plantuml @startuml alt text Bob -> Alice : hello @enduml ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNA0iHGISqeKIb8hIhYSyfCKTEqK77CoarCLh1GoKdDoyhaSKlDImEeXD000" alt="uml diagram"> . Anything inside diagrams will not be parsed . ```plantuml Bob -> Alice : hello # This wont be a title ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vr9M2Cd8B5OepyyhKKXALKXKACaioKdbSaZDIm7g0G00" alt="uml diagram"> . Marker could be indented up to 3 spaces . ```plantuml Bob -> Alice : hello ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IW80" alt="uml diagram"> . But that's a code block . ```plantuml Bob -> Alice : hello ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IW80" alt="uml diagram"> . Diagrams self-close at the end of the document . ```plantuml @startuml Bob -> Alice : hello ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNA0ivpoanHqxHGSSpAJKnMi539IStBokHnIyrA0aW00" alt="uml diagram"> . They should terminate paragraphs . ```plantuml blah blah @startuml Bob -> Alice : hello @enduml ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuKhAISnG015S3d0nf_ma1Lqx1SUSpEHK1Ik5ZDISd7mkXzIy590ab0O0" alt="uml diagram"> . They could be nested in lists . ```plantuml - @startuml Bob -> Alice : hello @enduml ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuT9LS82p5HGKdFAJ57Jj51npCfDJ5QmKCb9pSl91uWwfUIaW9L0Q0000" alt="uml diagram"> . List indentation quirks . ```plantuml - @startuml Bob -> Alice : hello @enduml - @startuml Bob -> Alice : hello @enduml ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuT9LK720SnI0m2a_IK7NJi4n9pCvLS5A8ICr9oSV9E6GcfS2KiEbWAw5a0ue3G00" alt="uml diagram"> . Timing diagram is supported . ```plantuml robust "Web Browser" as WB @0 WB is Idle @100 WB is Processing ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuIhAJoejBb5G2azDKd0goYylJYrIKaWiLWXtuk9oCE0ATrB8B5RmJCb91N8D3M020KNvoQd5nPbvwLmEgNafG8C0" alt="uml diagram"> . UML including non-english character is rendered correctly . ```plantuml 太郎 -> 花子 : こんにちは！ ``` . <img src="https://www.plantuml.com/plantuml/svg/SoWkIImgAStDuNgwPDNBvZu5NJk55rqRdwwTe62byBXnykEcoOyRLpzkNFYuSVtxFOrS3gbvAK3L0000" alt="uml diagram"> .