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

Merge pull request #3647 from DKurilo/feat/1414-notes-to-class-diagram

Browse Source 
add the way to add notes to class diagram
This commit is contained in:
Knut Sveidqvist
2022-10-25 14:45:03 +02:00
committed by GitHub
parent 427eaebd79 75e11b1fde
commit 27a68819bc
13 changed files with 290 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/classDiagram.md
View File

@@ -11,7 +11,9 @@ Mermaid can render class diagrams.
```mermaid-example
classDiagram
note "From Duck till Zebra"
Animal <|-- Duck
note for Duck "can fly\ncan swim\ncan dive\ncan help in debugging"
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
@@ -35,7 +37,9 @@ classDiagram
```mermaid
classDiagram
note "From Duck till Zebra"
Animal <|-- Duck
note for Duck "can fly\ncan swim\ncan dive\ncan help in debugging"
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
@@ -549,6 +553,10 @@ You would define these actions on a separate line after all classes have been de
- (_optional_) tooltip is a string to be displayed when hovering over element (note: The styles of the tooltip are set by the class .mermaidTooltip.)
- note: callback function will be called with the nodeId as parameter.
## Notes
It is possible to add notes on digram using `note "line1\nline2"` or note for class using `note for class "line1\nline2"`
### Examples
_URL Link:_