Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/snappey/d2.net

Fluent .NET Wrapper for creating D2 Language templates.
https://github.com/snappey/d2.net

csharp d2 d2lang diagram-generator diagramming dotnet

Last synced: about 2 months ago
JSON representation

Fluent .NET Wrapper for creating D2 Language templates.

Host: GitHub
URL: https://github.com/snappey/d2.net
Owner: Snappey
License: mit
Created: 2023-12-30T20:39:03.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2024-01-02T15:09:11.000Z (about 1 year ago)
Last Synced: 2024-04-26T07:01:08.492Z (9 months ago)
Topics: csharp, d2, d2lang, diagram-generator, diagramming, dotnet
Language: C#
Homepage:
Size: 48.8 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



D2.Net

    

        

    



A .NET Library for programatically creating D2 Templates.



[D2 Language](https://github.com/terrastruct/d2) created by Terrastruct

![Latest Version](https://img.shields.io/github/v/release/Snappey/D2.Net)

[![NuGet](https://img.shields.io/nuget/v/D2.Net.svg)](https://www.nuget.org/packages/D2.Net/)

![License](https://img.shields.io/github/license/Snappey/D2.Net.svg)



## 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

- [x] Shapes

  - [x] Labels

  - [x] Containers / Children

  - [x] Styling

- [x] Connections

  - [x] Labels

  - [x] Arrow Styling/Directions

  - [ ] Styling

- [ ] Tooltips / Links

- [x] Icons

- [x] Standalone Text / Markdown / LateX

- [ ] Sequence Diagrams

- [ ] UML/Class Diagrams

- [ ] SQL Table Diagrams

## Installation

D2.Net is available on [NuGet](https://www.nuget.org/packages/D2.Net/).

```bash

dotnet add package D2.Net

```

## Usage

Here is an example of creating a fairly complex template using D2.Net with most of the implemented features.

You can check Examples to see this and a more basic setup.

```csharp

using D2;

var styledTemplate = Diagram.Create()

    .CreateShape("D", type: ShapeType.Circle)

    .CreateShape("E", "Styled Shape", ShapeType.Hexagon)

    .CreateShape("F", "Styled Diamond Shape", ShapeType.Diamond)

    .CreateDirectionalConnection("D", "E", "Styled Connection", new ArrowheadOptions(ArrowheadType.CrowsFootManyRequired, "Filled Triangle"))

    .CreateBidirectionalConnection("E", "F", "Bidirectional Connection",

        new ArrowheadOptions(ArrowheadType.CrowsFootManyRequired),

        new ArrowheadOptions(ArrowheadType.CrowsFootManyRequired))

    .CreateConnection("F", "D")

    .CreateMarkdownShape("G", @"  # I can do headers

  - lists

  - lists

  And other normal markdown stuff")

    .CreateLatexShape("H", @"\\lim_{h \\rightarrow 0 } \\frac{f(x+h)-f(x)}{h}")

    .CreateBidirectionalConnection("G", "H");

Console.WriteLine(styledTemplate);

```

This will output the following D2 code:

```d2

D: {

  shape: circle

}

E: Styled Shape {

  shape: hexagon

}

F: Styled Diamond Shape {

  shape: diamond

}

D -> E: Styled Connection {

  target-arrowhead: Filled Triangle { shape: cf-many-required; style.filled: true }

}

E <-> F: Bidirectional Connection {

  source-arrowhead: { shape: cf-many-required; style.filled: true }

  target-arrowhead: { shape: cf-many-required; style.filled: true }

}

F -> D

G: |md

  # I can do headers

  - lists

  - lists

  And other normal markdown stuff|

H: |latex

\\lim_{h \\rightarrow 0 } \\frac{f(x+h)-f(x)}{h}|

G <-> H: Bidirectional Connection {

  source-arrowhead: { shape: cf-many-required; style.filled: true }

  target-arrowhead: { shape: cf-many-required; style.filled: true }

}

```

That is rendered to the following diagram, using the [D2 Playground]([https://play.d2lang.com/?script=crRSCC5JLCrJzEtXCMjPzCvhcrJScM1LQfCdrRR8M1NSclIhfIVqLgUFBYXijMSCVCuFjNSKxPT8PK5aLkcFXTsFZy5nEOVkpeCRmpOTrxCeX5STosgFCAAA__8%3D&](https://play.d2lang.com/?script=1JBBi9swFITv71cM9JJQXHpWS6Ct66Tn9GhYhPVsiZWl3WeZONj-74sdyIYllxz3JphPM_MmVxgJ6Kx-YYXKSeWZZvqrcExnzwbHRbllLA-6iYFmKq5Q7nQbwx3YXASaKUe2w7vtnxgCV8nFsOJJS8Mp0yLxZFkbhcL5hfsvTofGM8ZrxzprdThnwq-9EzY_0C2W3-r1g0KSnjEvN-BntkOh8NsZJ5cw7T8md7GXim-TH0261_7xtsWyT057hak1BHzBP1Q6wEQsliwdEZDBuy51Ny8CfgWDmCwLQpRWe7Rank08BXSpr-uJDgqT14kHKkvv2qfRoizFNTatlfEdM8qyFl2N9Wb4ardZvRm282jnifbriodPsuJbAAAA__8%3D&sketch=0&))!

![Basic Template](./assets/d2-readme.png)