FoggyBalrog.MermaidDotNet Documentation
FoggyBalrog.MermaidDotNet is .NET library to generate Mermaid diagrams code.
Note
This documentation applies to the latest published version, excluding pre-releases.
See the source code on GitHub: FoggyBalrog/MermaidDotNet.
Add the library to your project
Install the FoggyBalrog.MermaidDotNet NuGet package from nuget.org, or download the nupkg file from the latest release on GitHub.
Compatibility
The library targets .NET Standard 2.1, that is notably compatible with .NET Core 3.0 and later, .NET 5.0 and later, and Mono 6.4 and later.
See details on the package frameworks tab on nuget.org or on Microsoft Learn.
Quick Start
Flowchart
string diagram = Mermaid
.Flowchart()
.AddNode("N1", out var n1)
.AddNode("N2", out var n2)
.AddNode("N3", out var n3)
.AddLink(n1, n2, "some text")
.AddLink(n2, n3)
.Build();
flowchart TB
id1["N1"]
id2["N2"]
id3["N3"]
id1 -->|"some text"| id2
id2 --> id3
Read more on flowchart.
Sequence diagram
string diagram = Mermaid
.SequenceDiagram()
.AddParticipant("Alice", out var a)
.AddParticipant("Bob", out var b)
.SendMessage(a, b, $"Hello {b.Name}!")
.SendMessage(b, a, $"Hello {a.Name}!")
.Build();
sequenceDiagram
participant Alice
participant Bob
Alice->>Bob: Hello Bob!
Bob->>Alice: Hello Alice!
Read more on sequence-diagram.
Class diagram
var diagram = Mermaid
.ClassDiagram()
.AddClass("Animal", out var animal)
.AddClass("Dog", out var dog)
.AddProperty(animal, "int", "Age")
.AddMethod(animal, null, "Breathe")
.AddMethod(animal, "void", "Eat", parameters:
[
("Food", "food")
])
.AddMethod(dog, "Sound", "Bark", parameters:
[
("int", "times"),
("int", "volume")
])
.AddRelationship(animal, dog, RelationshipType.Inheritance, label: "A dog is an animal")
.Build();
classDiagram
class Animal {
+int Age
+Breathe()
+Eat(Food food) Energy
}
class Dog {
+Bark(int times, int volume) Sound
}
Animal <|-- Dog : A dog is an animal
Read more on class-diagram.
State diagram
var diagram = Mermaid
.StateDiagram()
.AddState("State 1", out var s1)
.AddState("State 2", out var s2)
.AddTransitionFromStart(s1)
.AddStateTransition(s1, s2)
.AddTransitionToEnd(s2)
.Build();
stateDiagram-v2
s1 : State 1
s2 : State 2
[*] --> s1
s1 --> s2
s2 --> [*]
Read more on state-diagram.
Entity relationship diagram
string diagram = Mermaid
.EntityRelationshipDiagram()
.AddEntity("Customer", out var c)
.AddEntity("Order", out var o)
.AddEntity("Product", out var p)
.AddRelationship(Cardinality.ExactlyOne, c, Cardinality.ZeroOrMore, o, "places")
.AddRelationship(Cardinality.ExactlyOne, o, Cardinality.OneOrMore, p, "contains")
.Build();
erDiagram
Customer ||--o{ Order : "places"
Order ||--|{ Product : "contains"
Read more on entity-relationship-diagram.
User journey diagram
var diagram = Mermaid
.UserJourneyDiagram()
.AddTask("Task 1", 1, "Actor 1", "Actor 2")
.AddTask("Task 2", 2)
.AddSection("Section 1")
.AddTask("Task 3", 3)
.AddTask("Task 4", 4, "Actor 3")
.AddSection("Section 2")
.AddTask("Task 5", 5, "Actor 1", "Actor 3")
.AddTask("Task 6", 6, "Actor 2")
.Build();
journey
Task 1: 1: Actor 1, Actor 2
Task 2: 2
section Section 1
Task 3: 3
Task 4: 4: Actor 3
section Section 2
Task 5: 5: Actor 1, Actor 3
Task 6: 6: Actor 2
Read more on user-journey-diagram.
Gantt diagram
string diagram = Mermaid
.GanttDiagram()
.AddTask("Foo", Date("2024-05-01"), Date("2024-05-05"), out _)
.AddTask("Bar", Date("2024-05-08"), Date("2024-05-12"), out _)
.Build();
gantt
dateFormat YYYY-MM-DD
Foo: task1, 2024-05-01, 2024-05-05
Bar: task2, 2024-05-03, 2024-05-08
Read more on gantt-diagram.
Git graph
string graph = Mermaid
.GitGraph()
.Commit()
.Branch("dev", out Branch dev)
.Commit()
.Checkout(dev)
.Commit()
.Commit()
.CheckoutMain()
.Commit()
.Merge(dev)
.Commit()
.Build();
gitGraph
commit
branch dev
commit
checkout dev
commit
commit
checkout main
commit
merge dev
commit
Read more on git-graph.
Mind Map
var mindMap = Mermaid
.MindMap("Root")
.AddNode("Node 1", out var node1)
.AddNode("Node 2", out var node2, node1)
.AddNode("Node 3", out var node3, node1)
.AddNode("Node 4", out var node4, node2)
.AddNode("Node 5", out var node5, node2)
.AddNode("Node 6", out var node6, node3)
.AddNode("Node 7", out var node7, node3)
.Build();
mindmap
Root
Node 1
Node 2
Node 4
Node 5
Node 3
Node 6
Node 7
Read more on mind-map.
Pie chart
var pieChart = Mermaid
.PieChart()
.AddDataSet("Label1", 42.7)
.AddDataSet("Label2", 57.3)
.Build();
pie
"Label1": 42.7
"Label2": 57.3
Read more on pie-chart.
Quadrant chart
var quadrantChart = Mermaid
.QuadrantChart()
.AddPoint("A", 0.1, 0.2)
.AddPoint("B", 0.3, 0.4)
.Build();
quadrantChart
A: [0.1, 0.2]
B: [0.3, 0.4]
Read more on quadrant-chart.
Requirement diagram
string diagram = Mermaid
.RequirementDiagram()
.AddRequirement("Requirement 1", out var requirement1)
.AddRequirement("Requirement 2", out var requirement2)
.AddElement("Element 1", out var element1)
.AddElement("Element 2", out var element2)
.AddRelationship(element1, requirement1, RelationshipType.Satisfies)
.AddRelationship(element2, requirement2, RelationshipType.Satisfies)
.Build();
requirementDiagram
requirement "Requirement 1" {
}
requirement "Requirement 2" {
}
element "Element 1" {
}
element "Element 2" {
}
"Element 1" - satisfies -> "Requirement 1"
"Element 2" - satisfies -> "Requirement 2"
Read more on requirement-diagram.
Timeline diagram
string diagram = Mermaid
.TimelineDiagram("Some title")
.AddEvents("2021", "Event 1", "Event 2")
.AddEvents("2022", "Event 3")
.AddEvents("2023", "Event 4", "Event 5", "Event 6")
.Build();
timeline
title Some title
2021 : Event 1 : Event 2
2022 : Event 3
2023 : Event 4 : Event 5 : Event 6
Read more on timeline-diagram.
Unsafe mode
By default, the library uses safe mode, which means that it will throw an exception if the arguments passed to the methods are invalid.
You can disable this behavior by accessing the buiders through the Unsafe property in the Mermaid class.
Example:
string diagram = Mermaid
.Unsafe
.Flowchart()
.AddNode("N1", out var n1)
.AddNode("N2", out var n2)
.AddNode("N3", out var n3)
.AddLink(n1, n2, "some text")
.AddLink(n2, n3)
.Build();
License
This project is licensed under the MIT License. See the LICENSE file for details.
Credits
Mermaid icon created by Smashicons on Flaticon.