GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Richard Gibson 2015-11-06 10:24:51 -05:00
parent 26ebbf82ee
commit a59a5a2402
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/content/sequenceDiagram.md
View File

@ -74,7 +74,7 @@ There are six types of arrows currently supported:
## Notes
It is possible to add notes to a sequence diagram. This is done by the notation
Note [ right | left ] of [Actor]: Text in note content
Note [ right of | left of | over ] [Actor]: Text in note content
See the example below:
```
@ -92,18 +92,17 @@ sequenceDiagram
Note right of John: Text in note
```
It is possible to break text into different rows by using <br/> as a line breaker.
It is also possible to create notes spanning two participants:
```
%% Example of sequence diagram
sequenceDiagram
participant John
Note left of John: Text in note spanning several rows.
Alice->John: Hello John, how are you?
Note over Alice,John: A typical interaction
```
```mermaid
sequenceDiagram
participant John
Note left of John: Text in note spanning several rows.
Alice->John: Hello John, how are you?
Note over Alice,John: A typical interaction
```
## Loops
@ -309,4 +308,4 @@ mermaid.sequenceConfig = {
Param | Descriotion | Default value
--- | --- | ---
mirrorActor|Turns on/off the rendering of actors below the diagram as well as above it|false
bottomMarginAdj|Adjusts how far down the graph ended. Wide borders styles with css could generate unwantewd clipping which is why this config param exists.|1
bottomMarginAdj|Adjusts how far down the graph ended. Wide borders styles with css could generate unwantewd clipping which is why this config param exists.|1