Skip to content
a .Net wrapper for PlantUml
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src exposed ability to get the remote rendering url (#12) Feb 14, 2019
.gitignore Initial commit Apr 24, 2018
LICENSE Initial commit Apr 24, 2018
PlantUml.Net.sln initial check in Apr 30, 2018
readme.md Updated readme Jun 24, 2018

readme.md

PlantUml.Net

Build status

PlantUml.Net is a .Net wrapper for PlantUml

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);

Rendering Modes

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

Remote Rendering (default)

Remote rendering mode uses the PlantUml hosted service to render diagrams.

Local Rendering

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

Requirements

Java

Install Java. Ensure that the JAVA_HOME environment variable is set.

PlantUml

Download PlantUml. By default PlantUml.Net looks for plantuml.jar in the woring directory; you can specify an alternate location in PlantUmlSettings.

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.

You can’t perform that action at this time.