GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1885 from zepatrik/improve-special-character-docs

Browse Source 
Improve docs around escape characters
This commit is contained in:
Knut Sveidqvist 2021-02-18 18:57:28 +01:00 committed by GitHub
commit 4a594ed115
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/flowchart.md
View File

@ -497,6 +497,8 @@ It is possible to escape characters using the syntax exemplified here.
A["A double quote:#quot;"] -->B["A dec char:#9829;"] A["A double quote:#quot;"] -->B["A dec char:#9829;"]
``` ```
Numbers given are base 10, so `#` can be encoded as `#35;`. It is also supported to use HTML character names.
## Subgraphs ## Subgraphs
``` ```

17
docs/sequenceDiagram.md
View File

@ -347,6 +347,23 @@ sequenceDiagram
John-->>Alice: Great! John-->>Alice: Great!
``` ```
## Entity codes to escape characters
It is possible to escape characters using the syntax exemplified here.
```
sequenceDiagram
A->>B: I #9829; you!
B->>A: I #9829; you #infin; times more!
```
```mermaid
sequenceDiagram
A->>B: I #9829; you!
B->>A: I #9829; you #infin; times more!
```
Numbers given are base 10, so `#` can be encoded as `#35;`. It is also supported to use HTML character names.
## sequenceNumbers ## sequenceNumbers
It is possible to get a sequence number attached to each arrow in a sequence diagram. This can be configured when adding mermaid to the website as shown below: It is possible to get a sequence number attached to each arrow in a sequence diagram. This can be configured when adding mermaid to the website as shown below: