MermaidDiagrams 0.2.2
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package MermaidDiagrams --version 0.2.2
NuGet\Install-Package MermaidDiagrams -Version 0.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MermaidDiagrams" Version="0.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MermaidDiagrams --version 0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MermaidDiagrams, 0.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MermaidDiagrams as a Cake Addin #addin nuget:?package=MermaidDiagrams&version=0.2.2 // Install MermaidDiagrams as a Cake Tool #tool nuget:?package=MermaidDiagrams&version=0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Mermaid Diagrams
.net support for Mermaid diagrams
Flowcharts
Create a flowchart
Declare a chart and render it to a string.
var flow = new Flowchart();
var output = flow.Render();
Setup a flowchart
- Add
init
directive to set theme - Set a title with
SetHeader
- Add a comment with
AddComment
- Add nodes with
Node
- Add links with
Link
flow.AddDirective(new DirectiveInitialize(KnownThemes.Forest));
flow.SetHeader(new Header("This is a test"));
flow.Comment("No comment");
flow.AddNode("A", "Hard edge", Shape.Box)
.AddNode("B", "Round edge", Shape.RoundedBox);
flow.Link(flow["A"], flow["B"], Edge.Arrow.WithLabel("Link text"));
var c = flow.Node("C", "Decision", Shape.Rhombus);
var d = flow.Node("D", "Result One", Shape.Trapezoid);
var e = flow.Node("E", "Result Two", Shape.Circle);
flow.Link(flow["B"], c, Edge.Arrow);
flow.Link(c, d, Edge.Arrow.WithLabel("Yes"));
flow.Link(c, e, Edge.Arrow.WithLabel("No"));
Subgraphs
flow.Subgraph("Outer", Identifier.Next("sg"), FlowDirection.TopBottom,
sub =>
{
sub.Node("Something", Shape.Stadium);
var sg = sub.Subgraph("Inner", "in1");
sg.Node("A", "Hard edge", Shape.Box);
});
Theme and Styles
Define a style by name and assign it to a node by it's identifier.
flow.AddDirective(new DirectiveInitialize(KnownThemes.Forest));
// or
flow.SetTheme(KnownThemes.Forest);
// or
flow.SetTheme(new ThemeVariables() {
// set theme variables
});
var cd = flow.GetClassDefinitions();
cd.GetOrCreate("neat", s
=> new ClassDef(s)
.Style("fill", "#f96")
.Style("stroke", "#333")
.Style("stroke-width", "2px")
.Assign("A")
);
Other charts
To be done...
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Json (>= 6.0.0)
-
.NETStandard 2.1
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Json (>= 6.0.0)
-
net6.0
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Json (>= 6.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.