marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-29 20:29:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation with comment syntax

Browse Source
This commit is contained in:
Justin Greywolf
2019-11-26 15:34:52 -08:00
parent 4ff5c3b455
commit d26a67297a
5 changed files with 64 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/sequenceDiagram.md
View File

@@ -271,7 +271,16 @@ sequenceDiagram
```
## Comments
Comments can be entered within a sequence diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any diagram syntax
```
sequenceDiagram
Alice->>John: Hello John, how are you?
%% this is a comment
John-->>Alice: Great!
```
## Styling