PlantUml.Net
1.2.40
See the version list below for details.
dotnet add package PlantUml.Net --version 1.2.40
NuGet\Install-Package PlantUml.Net -Version 1.2.40
<PackageReference Include="PlantUml.Net" Version="1.2.40" />
paket add PlantUml.Net --version 1.2.40
#r "nuget: PlantUml.Net, 1.2.40"
// Install PlantUml.Net as a Cake Addin #addin nuget:?package=PlantUml.Net&version=1.2.40 // Install PlantUml.Net as a Cake Tool #tool nuget:?package=PlantUml.Net&version=1.2.40
PlantUml.Net
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 is compatible. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Framework | net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETCoreApp 2.0
- System.Net.Http (>= 4.3.3)
-
.NETFramework 4.6.1
- System.Net.Http (>= 4.3.3)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on PlantUml.Net:
Package | Downloads |
---|---|
Docfx.MarkdigEngine.Extensions
Technical documentation tool with markdown, API docs for .NET, REST API and more. |
|
BinaryDataDecoders.Text.Markdown
Package Description |
|
Synergy.Architecture.Diagrams
Behaviour Driven Development support |
|
MEF.DEV.DocHelper
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on PlantUml.Net:
Repository | Stars |
---|---|
dotnet/docfx
Static site generator for .NET API documentation.
|