FoggyBalrog.MermaidDotNet 0.1.0

MermaidDotNet

<img src="./mermaid.png" alt="Mermaid icon" width="100"/>

A .NET library to generate Mermaid diagrams from C# code.

[!WARNING]
Still under development. Not ready for production.

• Quick Start
  • Flowchart
  • Sequence diagram
  • Entity relationship diagram
• License
• Credits

Quick Start

The following code samples show how to create a simple Mermaid diagram of each implemented diagram type.

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();

Read more at docs/flowchart.md.

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();

Read more at docs/sequence-diagram.md.

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();

Read more at docs/entity-relationship-diagram.md.

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.

Credits

Mermaid icon created by Smashicons on Flaticon.