| 6dd74de | | | 1 | <html> |
| 6dd74de | | | 2 | <head> |
| 6dd74de | | | 3 | <link href="https://fonts.googleapis.com/css?family=Montserrat&display=swap" rel="stylesheet" /> |
| 6dd74de | | | 4 | <link href="https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css" rel="stylesheet" /> |
| 6dd74de | | | 5 | <link |
| 6dd74de | | | 6 | rel="stylesheet" |
| 6dd74de | | | 7 | href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/font-awesome.min.css" |
| 6dd74de | | | 8 | /> |
| 6dd74de | | | 9 | <link |
| 6dd74de | | | 10 | href="https://fonts.googleapis.com/css?family=Noto+Sans+SC&display=swap" |
| 6dd74de | | | 11 | rel="stylesheet" |
| 6dd74de | | | 12 | /> |
| 6dd74de | | | 13 | <style> |
| 6dd74de | | | 14 | body { |
| 6dd74de | | | 15 | /* background: rgb(221, 208, 208); */ |
| 6dd74de | | | 16 | background: #f4f4f4; |
| 6dd74de | | | 17 | background: #222; |
| 6dd74de | | | 18 | font-family: 'Arial'; |
| 6dd74de | | | 19 | height: 100%; |
| 6dd74de | | | 20 | width: 100%; |
| 6dd74de | | | 21 | margin: 0; |
| 6dd74de | | | 22 | padding: 0; |
| 6dd74de | | | 23 | } |
| 6dd74de | | | 24 | h1 { |
| 6dd74de | | | 25 | color: grey; |
| 6dd74de | | | 26 | } |
| 6dd74de | | | 27 | .mermaid2 { |
| 6dd74de | | | 28 | display: none; |
| 6dd74de | | | 29 | } |
| 6dd74de | | | 30 | .height { |
| 6dd74de | | | 31 | min-height: 600px; |
| 6dd74de | | | 32 | height: 600px; |
| 6dd74de | | | 33 | } |
| 6dd74de | | | 34 | .height2 { |
| 6dd74de | | | 35 | min-height: 600px; |
| 6dd74de | | | 36 | height: 1300px; |
| 6dd74de | | | 37 | } |
| 6dd74de | | | 38 | .width { |
| 6dd74de | | | 39 | width: 33%; |
| 6dd74de | | | 40 | border: 1px solid blue; |
| 6dd74de | | | 41 | padding: 10px; |
| 6dd74de | | | 42 | } |
| 6dd74de | | | 43 | </style> |
| 6dd74de | | | 44 | </head> |
| 6dd74de | | | 45 | <body> |
| 6dd74de | | | 46 | <h1>Showcases of diagrams</h1> |
| 6dd74de | | | 47 | <div class="flex flex-wrap"> |
| 6dd74de | | | 48 | <pre class="mermaid width height"> |
| 6dd74de | | | 49 | graph TD |
| 6dd74de | | | 50 | A[Christmas] -->|Get money| B(Go shopping) |
| 6dd74de | | | 51 | B --> C{Let me think} |
| 6dd74de | | | 52 | B --> G[/Another/] |
| 6dd74de | | | 53 | C ==>|One| D[Laptop] |
| 6dd74de | | | 54 | C -->|Two| E[iPhone] |
| 6dd74de | | | 55 | C -->|Three| F[fa:fa-car Car] |
| 6dd74de | | | 56 | subgraph section |
| 6dd74de | | | 57 | C |
| 6dd74de | | | 58 | D |
| 6dd74de | | | 59 | E |
| 6dd74de | | | 60 | F |
| 6dd74de | | | 61 | G |
| 6dd74de | | | 62 | end |
| 6dd74de | | | 63 | </pre> |
| 6dd74de | | | 64 | <pre class="mermaid width height"> |
| 6dd74de | | | 65 | %%{init2: {'securityLevel': 'loose', 'theme':'base'}}%% |
| 6dd74de | | | 66 | flowchart TD |
| 6dd74de | | | 67 | A[Christmas] -->|Get money| B(Go shopping) |
| 6dd74de | | | 68 | B --> C{Let me think} |
| 6dd74de | | | 69 | B --> G[Another] |
| 6dd74de | | | 70 | C ==>|One| D[Laptop] |
| 6dd74de | | | 71 | C x--x|Two| E[iPhone] |
| 6dd74de | | | 72 | C o--o|Three| F[fa:fa-car Car] |
| 6dd74de | | | 73 | subgraph section |
| 6dd74de | | | 74 | C |
| 6dd74de | | | 75 | D |
| 6dd74de | | | 76 | E |
| 6dd74de | | | 77 | F |
| 6dd74de | | | 78 | G |
| 6dd74de | | | 79 | end |
| 6dd74de | | | 80 | </pre> |
| 6dd74de | | | 81 | <pre class="mermaid width height"> |
| 6dd74de | | | 82 | sequenceDiagram |
| 6dd74de | | | 83 | autonumber |
| 6dd74de | | | 84 | par Action 1 |
| 6dd74de | | | 85 | Alice->>John: Hello John, how are you? |
| 6dd74de | | | 86 | and Action 2 |
| 6dd74de | | | 87 | Alice->>Bob: Hello Bob, how are you? |
| 6dd74de | | | 88 | end |
| 6dd74de | | | 89 | Alice->>+John: Hello John, how are you? |
| 6dd74de | | | 90 | Alice->>+John: John, can you hear me? |
| 6dd74de | | | 91 | John-->>-Alice: Hi Alice, I can hear you! |
| 6dd74de | | | 92 | Note right of John: John is perceptive |
| 6dd74de | | | 93 | John-->>-Alice: I feel great! |
| 6dd74de | | | 94 | loop Every minute |
| 6dd74de | | | 95 | John-->Alice: Great! |
| 6dd74de | | | 96 | end |
| 6dd74de | | | 97 | </pre> |
| 6dd74de | | | 98 | <pre class="mermaid width height"> |
| 6dd74de | | | 99 | classDiagram |
| 6dd74de | | | 100 | Animal "1" <|-- Duck |
| 6dd74de | | | 101 | Animal <|-- Fish |
| 6dd74de | | | 102 | Animal <--o Zebra |
| 6dd74de | | | 103 | Animal : +int age |
| 6dd74de | | | 104 | Animal : +String gender |
| 6dd74de | | | 105 | Animal: +isMammal() |
| 6dd74de | | | 106 | Animal: +mate() |
| 6dd74de | | | 107 | class Duck{ |
| 6dd74de | | | 108 | +String beakColor |
| 6dd74de | | | 109 | +swim() |
| 6dd74de | | | 110 | +quack() |
| 6dd74de | | | 111 | } |
| 6dd74de | | | 112 | class Fish{ |
| 6dd74de | | | 113 | -int sizeInFeet |
| 6dd74de | | | 114 | -canEat() |
| 6dd74de | | | 115 | } |
| 6dd74de | | | 116 | class Zebra{ |
| 6dd74de | | | 117 | +bool is_wild |
| 6dd74de | | | 118 | +run() |
| 6dd74de | | | 119 | } |
| 6dd74de | | | 120 | </pre> |
| 6dd74de | | | 121 | <pre class="mermaid width height"> |
| 6dd74de | | | 122 | gantt |
| 6dd74de | | | 123 | dateFormat :YYYY-MM-DD |
| 6dd74de | | | 124 | title Adding GANTT diagram functionality to mermaid |
| 6dd74de | | | 125 | excludes :excludes the named dates/days from being included in a charted task.. |
| 6dd74de | | | 126 | section A section |
| 6dd74de | | | 127 | Completed task :done, des1, 2014-01-06,2014-01-08 |
| 6dd74de | | | 128 | Active task :active, des2, 2014-01-09, 3d |
| 6dd74de | | | 129 | Future task : des3, after des2, 5d |
| 6dd74de | | | 130 | Future task2 : des4, after des3, 5d |
| 6dd74de | | | 131 | |
| 6dd74de | | | 132 | section Critical tasks |
| 6dd74de | | | 133 | Completed task in the critical line :crit, done, 2014-01-06,24h |
| 6dd74de | | | 134 | Implement parser and jison :crit, done, after des1, 2d |
| 6dd74de | | | 135 | Create tests for parser :crit, active, 3d |
| 6dd74de | | | 136 | Future task in critical line :crit, 5d |
| 6dd74de | | | 137 | Create tests for renderer :2d |
| 6dd74de | | | 138 | Add to mermaid :1d |
| 6dd74de | | | 139 | |
| 6dd74de | | | 140 | section Documentation |
| 6dd74de | | | 141 | Describe gantt syntax :active, a1, after des1, 3d |
| 6dd74de | | | 142 | Add gantt diagram to demo page :after a1 , 20h |
| 6dd74de | | | 143 | Add another diagram to demo page :doc1, after a1 , 48h |
| 6dd74de | | | 144 | |
| 6dd74de | | | 145 | section Last section |
| 6dd74de | | | 146 | Describe gantt syntax :after doc1, 3d |
| 6dd74de | | | 147 | Add gantt diagram to demo page :20h |
| 6dd74de | | | 148 | Add another diagram to demo page :48h |
| 6dd74de | | | 149 | </pre> |
| 6dd74de | | | 150 | <pre class="mermaid width height2"> |
| 6dd74de | | | 151 | stateDiagram |
| 6dd74de | | | 152 | [*] --> Active |
| 6dd74de | | | 153 | |
| 6dd74de | | | 154 | state Active { |
| 6dd74de | | | 155 | [*] --> NumLockOff |
| 6dd74de | | | 156 | NumLockOff --> NumLockOn : EvNumLockPressed |
| 6dd74de | | | 157 | NumLockOn --> NumLockOff : EvNumLockPressed |
| 6dd74de | | | 158 | -- |
| 6dd74de | | | 159 | [*] --> CapsLockOff |
| 6dd74de | | | 160 | CapsLockOff --> CapsLockOn : EvCapsLockPressed |
| 6dd74de | | | 161 | CapsLockOn --> CapsLockOff : EvCapsLockPressed |
| 6dd74de | | | 162 | -- |
| 6dd74de | | | 163 | [*] --> ScrollLockOff |
| 6dd74de | | | 164 | ScrollLockOff --> ScrollLockOn : EvCapsLockPressed |
| 6dd74de | | | 165 | ScrollLockOn --> ScrollLockOff : EvCapsLockPressed |
| 6dd74de | | | 166 | } |
| 6dd74de | | | 167 | state SomethingElse { |
| 6dd74de | | | 168 | A --> B |
| 6dd74de | | | 169 | B --> A |
| 6dd74de | | | 170 | } |
| 6dd74de | | | 171 | |
| 6dd74de | | | 172 | Active --> SomethingElse |
| 6dd74de | | | 173 | note right of SomethingElse : This is the note to the right. |
| 6dd74de | | | 174 | |
| 6dd74de | | | 175 | SomethingElse --> [*] |
| 6dd74de | | | 176 | </pre> |
| 6dd74de | | | 177 | <pre class="mermaid width height2"> |
| 6dd74de | | | 178 | stateDiagram-v2 |
| 6dd74de | | | 179 | [*] --> Active |
| 6dd74de | | | 180 | |
| 6dd74de | | | 181 | state Active { |
| 6dd74de | | | 182 | [*] --> NumLockOff |
| 6dd74de | | | 183 | NumLockOff --> NumLockOn : EvNumLockPressed |
| 6dd74de | | | 184 | NumLockOn --> NumLockOff : EvNumLockPressed |
| 6dd74de | | | 185 | -- |
| 6dd74de | | | 186 | [*] --> CapsLockOff |
| 6dd74de | | | 187 | CapsLockOff --> CapsLockOn : EvCapsLockPressed |
| 6dd74de | | | 188 | CapsLockOn --> CapsLockOff : EvCapsLockPressed |
| 6dd74de | | | 189 | -- |
| 6dd74de | | | 190 | [*] --> ScrollLockOff |
| 6dd74de | | | 191 | ScrollLockOff --> ScrollLockOn : EvCapsLockPressed |
| 6dd74de | | | 192 | ScrollLockOn --> ScrollLockOff : EvCapsLockPressed |
| 6dd74de | | | 193 | } |
| 6dd74de | | | 194 | state SomethingElse { |
| 6dd74de | | | 195 | A --> B |
| 6dd74de | | | 196 | B --> A |
| 6dd74de | | | 197 | } |
| 6dd74de | | | 198 | |
| 6dd74de | | | 199 | Active --> SomethingElse2 |
| 6dd74de | | | 200 | note right of SomethingElse2 : This is the note to the right. |
| 6dd74de | | | 201 | |
| 6dd74de | | | 202 | SomethingElse2 --> [*] |
| 6dd74de | | | 203 | </pre> |
| 6dd74de | | | 204 | <pre class="mermaid width height2"> |
| 6dd74de | | | 205 | erDiagram |
| 6dd74de | | | 206 | CUSTOMER }|..|{ DELIVERY-ADDRESS : has |
| 6dd74de | | | 207 | CUSTOMER ||--o{ ORDER : places |
| 6dd74de | | | 208 | CUSTOMER ||--o{ INVOICE : "liable for" |
| 6dd74de | | | 209 | DELIVERY-ADDRESS ||--o{ ORDER : receives |
| 6dd74de | | | 210 | INVOICE ||--|{ ORDER : covers |
| 6dd74de | | | 211 | ORDER ||--|{ ORDER-ITEM : includes |
| 6dd74de | | | 212 | PRODUCT-CATEGORY ||--|{ PRODUCT : contains |
| 6dd74de | | | 213 | PRODUCT ||--o{ ORDER-ITEM : "ordered in" |
| 6dd74de | | | 214 | </pre> |
| 6dd74de | | | 215 | <pre class="mermaid width height"> |
| 6dd74de | | | 216 | journey |
| 6dd74de | | | 217 | title My working day |
| 6dd74de | | | 218 | section Go to work |
| 6dd74de | | | 219 | Make tea: 5: Me |
| 6dd74de | | | 220 | Go upstairs: 3: Me |
| 6dd74de | | | 221 | Do work: 1: Me, Cat |
| 6dd74de | | | 222 | section Go home |
| 6dd74de | | | 223 | Go downstairs: 5: Me |
| 6dd74de | | | 224 | Sit down: 5: Me |
| 6dd74de | | | 225 | </pre> |
| 6dd74de | | | 226 | <pre class="mermaid width height"> |
| 6dd74de | | | 227 | requirementDiagram |
| 6dd74de | | | 228 | |
| 6dd74de | | | 229 | requirement test_req { |
| 6dd74de | | | 230 | id: 1 |
| 6dd74de | | | 231 | text: the test text. |
| 6dd74de | | | 232 | risk: high |
| 6dd74de | | | 233 | verifymethod: test |
| 6dd74de | | | 234 | } |
| 6dd74de | | | 235 | |
| 6dd74de | | | 236 | functionalRequirement test_req2 { |
| 6dd74de | | | 237 | id: 1.1 |
| 6dd74de | | | 238 | text: the second test text. |
| 6dd74de | | | 239 | risk: low |
| 6dd74de | | | 240 | verifymethod: inspection |
| 6dd74de | | | 241 | } |
| 6dd74de | | | 242 | |
| 6dd74de | | | 243 | performanceRequirement test_req3 { |
| 6dd74de | | | 244 | id: 1.2 |
| 6dd74de | | | 245 | text: the third test text. |
| 6dd74de | | | 246 | risk: medium |
| 6dd74de | | | 247 | verifymethod: demonstration |
| 6dd74de | | | 248 | } |
| 6dd74de | | | 249 | |
| 6dd74de | | | 250 | element test_entity { |
| 6dd74de | | | 251 | type: simulation |
| 6dd74de | | | 252 | } |
| 6dd74de | | | 253 | |
| 6dd74de | | | 254 | element test_entity2 { |
| 6dd74de | | | 255 | type: word doc |
| 6dd74de | | | 256 | docRef: reqs/test_entity |
| 6dd74de | | | 257 | } |
| 6dd74de | | | 258 | |
| 6dd74de | | | 259 | |
| 6dd74de | | | 260 | test_entity - satisfies -> test_req2 |
| 6dd74de | | | 261 | test_req - traces -> test_req2 |
| 6dd74de | | | 262 | test_req - contains -> test_req3 |
| 6dd74de | | | 263 | test_req <- copies - test_entity2 |
| 6dd74de | | | 264 | </pre> |
| 6dd74de | | | 265 | <pre class="mermaid" class="width height"> |
| 6dd74de | | | 266 | gitGraph |
| 6dd74de | | | 267 | commit |
| 6dd74de | | | 268 | branch hotfix |
| 6dd74de | | | 269 | checkout hotfix |
| 6dd74de | | | 270 | commit |
| 6dd74de | | | 271 | branch develop |
| 6dd74de | | | 272 | checkout develop |
| 6dd74de | | | 273 | commit id:"An id" tag:"A tag" |
| 6dd74de | | | 274 | branch featureB |
| 6dd74de | | | 275 | checkout featureB |
| 6dd74de | | | 276 | commit type:HIGHLIGHT |
| 6dd74de | | | 277 | checkout main |
| 6dd74de | | | 278 | checkout hotfix |
| 6dd74de | | | 279 | commit type:NORMAL |
| 6dd74de | | | 280 | checkout develop |
| 6dd74de | | | 281 | commit type:REVERSE |
| 6dd74de | | | 282 | checkout featureB |
| 6dd74de | | | 283 | commit |
| 6dd74de | | | 284 | checkout main |
| 6dd74de | | | 285 | merge hotfix |
| 6dd74de | | | 286 | checkout featureB |
| 6dd74de | | | 287 | commit |
| 6dd74de | | | 288 | checkout develop |
| 6dd74de | | | 289 | branch featureA |
| 6dd74de | | | 290 | commit |
| 6dd74de | | | 291 | checkout develop |
| 6dd74de | | | 292 | merge hotfix |
| 6dd74de | | | 293 | checkout featureA |
| 6dd74de | | | 294 | commit |
| 6dd74de | | | 295 | checkout featureB |
| 6dd74de | | | 296 | commit |
| 6dd74de | | | 297 | checkout develop |
| 6dd74de | | | 298 | merge featureA |
| 6dd74de | | | 299 | branch release |
| 6dd74de | | | 300 | checkout release |
| 6dd74de | | | 301 | commit |
| 6dd74de | | | 302 | checkout main |
| 6dd74de | | | 303 | commit |
| 6dd74de | | | 304 | checkout release |
| 6dd74de | | | 305 | merge main |
| 6dd74de | | | 306 | checkout develop |
| 6dd74de | | | 307 | merge release |
| 6dd74de | | | 308 | |
| 6dd74de | | | 309 | </pre> |
| 6dd74de | | | 310 | </div> |
| 6dd74de | | | 311 | <script type="module"> |
| 6dd74de | | | 312 | import mermaid from './mermaid.esm.mjs'; |
| 6dd74de | | | 313 | mermaid.parseError = function (err, hash) { |
| 6dd74de | | | 314 | // console.error('Mermaid error: ', err); |
| 6dd74de | | | 315 | }; |
| 6dd74de | | | 316 | mermaid.initialize({ |
| 6dd74de | | | 317 | theme: 'base', |
| 6dd74de | | | 318 | themeVariables: { |
| 6dd74de | | | 319 | primaryColor: '#9400D3', |
| 6dd74de | | | 320 | darkMode: true, |
| 6dd74de | | | 321 | background: '#222', |
| 6dd74de | | | 322 | textColor: 'white', |
| 6dd74de | | | 323 | primaryTextColor: '#f4f4f4', |
| 6dd74de | | | 324 | nodeBkg: '#ff0000', |
| 6dd74de | | | 325 | mainBkg: '#0000ff', |
| 6dd74de | | | 326 | tertiaryColor: '#ffffcc', |
| 6dd74de | | | 327 | }, |
| 6dd74de | | | 328 | // arrowMarkerAbsolute: true, |
| 6dd74de | | | 329 | // themeCSS: '.edgePath .path {stroke: red;} .arrowheadPath {fill: red;}', |
| 6dd74de | | | 330 | logLevel: 0, |
| 6dd74de | | | 331 | flowchart: { curve: 'cardinal', htmlLabels: false }, |
| 6dd74de | | | 332 | // gantt: { axisFormat: '%m/%d/%Y' }, |
| 6dd74de | | | 333 | sequence: { actorMargin: 50, showSequenceNumbers: true }, |
| 6dd74de | | | 334 | // sequenceDiagram: { actorMargin: 300 } // deprecated |
| 6dd74de | | | 335 | fontFamily: '"arial", sans-serif', |
| 6dd74de | | | 336 | curve: 'cardinal', |
| 6dd74de | | | 337 | // securityLevel: 'strict' |
| 6dd74de | | | 338 | }); |
| 6dd74de | | | 339 | function callback() { |
| 6dd74de | | | 340 | alert('It worked'); |
| 6dd74de | | | 341 | } |
| 6dd74de | | | 342 | </script> |
| 6dd74de | | | 343 | </body> |
| 6dd74de | | | 344 | </html> |