Home A - Z
Menu

An Otter Wiki

Blame

8c227e Ralph Thesen 2025-08-10 22:38:23
Added Examples/Mermaid
1 
# Mermaid
2
3
## Kanban
4
5
```mermaid
6
---
7
config:
8
kanban:
9
ticketBaseUrl: 'https://github.com/redimp/otterwiki/issues/#TICKET#'
10
---
11
kanban
12
todo[Todo]
13
id150[Allow removing pages without their subpages]@{ ticket: '150' }
14
id128[Request a convenient way to add wikilink]@{ ticket: '128' }
15
inprogress[In Progress]
16
id164[Mermaid diagram engine is outdated]@{ ticket: '164', assigned: 'redimp', priority: 'High' }
17
done[Done]
18
id152[Otterwiki serves almost no files]@{ ticket: '152', assigned: 'redimp', priority: 'Low' }
19
```
20
21
## Graph
22
23
```mermaid
24
graph LR
25
A[Square Rect] -- Link text --> B((Circle))
26
A --> C(Round Rect)
27
B --> D{Rhombus}
28
C --> D
29
```
30
31
## Subgraph
32
33
```mermaid
34
graph TB
35
sq[Square shape] --> ci((Circle shape))
36
37
subgraph A["subgraph title"]
38
od>Odd shape]-- Two line\nedge comment --> ro
39
di{Diamond with \n line break} -.-> ro(Rounded<br>square<br>shape)
40
di==>ro2(Rounded square shape)
41
end
42
```
43
44
## Git Graph
45
46
```mermaid
47
gitGraph:
48
commit "Ashish"
49
branch newbranch
50
checkout newbranch
51
commit id:"1111"
52
commit tag:"test"
53
checkout main
54
commit type: HIGHLIGHT
55
commit
56
merge newbranch
57
commit
58
branch b2
59
commit
60
```
61
62
## Sequence Diagram
63
64
```mermaid
65
sequenceDiagram
66
participant web as Web Browser
67
participant blog as Blog Service
68
participant account as Account Service
69
participant mail as Mail Service
70
participant db as Storage
71
72
Note over web,db: The user must be logged in to submit blog posts
73
web->>+account: Logs in using credentials
74
account->>db: Query stored accounts
75
db->>account: Respond with query result
76
77
alt Credentials not found
78
account->>web: Invalid credentials
79
else Credentials found
80
account->>-web: Successfully logged in
81
82
Note over web,db: When the user is authenticated, they can now submit new posts
83
web->>+blog: Submit new post
84
blog->>db: Store post data
85
86
par Notifications
87
blog--)mail: Send mail to blog subscribers
88
blog--)db: Store in-site notifications
89
and Response
90
blog-->>-web: Successfully posted
91
end
92
end
93
```