zhuyadong / PlantUml.Net

a .Net wrapper for PlantUml

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PlantUml.Net

Build status

PlantUml.Net is a .Net wrapper for PlantUml

Rendering Modes

PlantUml.Net can render in 2 modes, Local and Remote.

Local Rendering

Local rendering mode uses a local copy of PlantUml to render diagrams.

Remote Rendering

Remote rendering mode uses the PlantUml hosted service to render diagrams

Requirements

Java

Install Java Ensure that the JAVA_HOME environment variable is set

GraphViz Dot (optional)

GraphViz Dot is required for Local rendering mode of any diagram other than sequence.

Install GraphViz Dot You may need to set the GRAPHVIZ_DOT environment variable

see the PlantUml documentation for more detailed instructions

Installation

Add to your project via NuGet

Usage

var factory = new RendererFactory();

var renderer = factory.CreateRenderer(new PlantUmlSettings());

var bytes = renderer.Render("Bob -> Alice : Hello", OutputFormat.Png);
File.WriteAllBytes("out.png", bytes);

About

a .Net wrapper for PlantUml

License:MIT License


Languages

Language:C# 100.0%