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

https://github.com/energy164/plantuml.builder

A library with StringBuilder extension methods to make it easier to generate valid PlantUML diagrams using dotnet
https://github.com/energy164/plantuml.builder

plantuml stringbuilder

Last synced: 12 months ago
JSON representation

A library with StringBuilder extension methods to make it easier to generate valid PlantUML diagrams using dotnet

Awesome Lists containing this project

README

          

# PlantUML Builder

![.NET Core](https://github.com/eNeRGy164/PlantUml.Builder/workflows/.NET%20Core/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/eNeRGy164/PlantUml.Builder/badge.svg?branch=main)](https://coveralls.io/github/eNeRGy164/PlantUml.Builder?branch=main)

**PlantUML Builder** is a library with StringBuilder extension methods to make it easier to generate valid PlantUML diagrams using .NET.

## Example

The following code:

```csharp
var stringBuilder = new StringBuilder();

stringBuilder.UmlDiagramStart();
stringBuilder.Arrow("Alice", "->", "Bob", "Authentication Request");
stringBuilder.Arrow("Bob", "-->", "Alice", "Authentication Response");
stringBuilder.AppendNewLine();
stringBuilder.Arrow("Alice", "->", "Bob", "Another authentication Request");
stringBuilder.Arrow("Alice", "<--", "Bob", "Another authentication Response");
stringBuilder.UmlDiagramEnd();

stringBuilder.ToString()
```

Generates the following output:

```plantuml
@startuml
Alice -> Bob : Authentication Request
Bob --> Alice : Authentication Response

Alice -> Bob : Another authentication Request
Alice <-- Bob : Another authentication Response
@enduml
```

## Implemented commands status

See [Implemented commands](./docs/commands.md).