D2.Net 0.1.0

About

This library aims to provide a simple and expressive way to create D2 templates that can be easily integrated into any .NET application. Enabling easy generation of diagrams for documentation, reports, and more based off of data from your application.

Currently this library is in early development and not all D2 features are supported, see below for a high level list of supported features.

Supported D2 Features

• Shapes
  • Labels
  • Containers / Children
  • Styling
• Connections
  • Labels
  • Arrow Styling/Directions
  • Styling
• Tooltips / Links
• Icons
• Standalone Text / Markdown / LateX
• Sequence Diagrams
• UML/Class Diagrams
• SQL Table Diagrams

Installation

D2.Net is available on NuGet.

dotnet add package D2.Net

Usage

Here is an example of creating a basic template using D2.Net.

using D2;

var A = new Shape("A", "Starting Point");
var B = new Shape("B", "Ending Point");
var C = new Shape("C", "Middle Point", ShapeType.Hexagon);

var basicTemplate = Diagram.Create()
  .Add(A)
  .Add(B)
  .Add(C)
  .Add(new Connection(A, C))
  .Add(new Connection(C, B, "Hello World!"));

// Each component overrides ToString() to return the D2 code for that instance
Console.WriteLine(basicTemplate);
// or you can use the Render() method
Console.WriteLine(basicTemplate.Render());

This will output the following D2 code:

A: Starting Point
B: Ending Point
C: Middle Point {
  shape: hexagon
}
A -> C
C -> B: Hello World!

That can then be rendered to a diagram using the D2 Playground!