Dhgms.DocFx.MermaidJs.Plugin 3.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Dhgms.DocFx.MermaidJs.Plugin --version 3.0.1                

                    
                

            
NuGet\Install-Package Dhgms.DocFx.MermaidJs.Plugin -Version 3.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Dhgms.DocFx.MermaidJs.Plugin" Version="3.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Dhgms.DocFx.MermaidJs.Plugin --version 3.0.1                

                    
                

            
#r "nuget: Dhgms.DocFx.MermaidJs.Plugin, 3.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Dhgms.DocFx.MermaidJs.Plugin as a Cake Addin
#addin nuget:?package=Dhgms.DocFx.MermaidJs.Plugin&version=3.0.1

// Install Dhgms.DocFx.MermaidJs.Plugin as a Cake Tool
#tool nuget:?package=Dhgms.DocFx.MermaidJs.Plugin&version=3.0.1

DocFx MermaidJS

Mission Statement

To provide a plugin to convert MermaidJS notations to diagrams during the build of a DocFX project.

Introduction

This DocFX MermaidJS plugin is a wrapper around the mermaid NPM package. It is aimed at doing build time generation of the mermaid diagram so:

  • The syntax can be validated at build time.
  • The image is only built once.
  • The image can be embedded in a pdf.

Credits

Getting Started

1. Create a console application (or similar)

2. Add a nuget package reference to "Dhgms.DocFX.Mermaid.Plugin" in your docfx_project

3. Add the following initialisation

                var options = new BuildOptions
                {
                    // Enable MermaidJS markdown extension
                    ConfigureMarkdig = pipeline => pipeline.UseMermaidJsExtension(new MarkdownContext())
                };
                await Docset.Build("docfx.json", options);

You can see an example of this in

  1. The sample console application in this repository (github.com/dpvreony/docfx-mermaidjs/tree/main/src/Dhgms.DocFx.MermaidJs.Sample.Cmd)
  2. The console application in my main documentation repository (github.com/dpvreony/documentation/tree/main/src/docfx_project)

NOTES:

  • Only inline PNG is supported, this is due to a limitation in the plug in model and adding new files to the file cache on the fly. I may revisit this in future. The plug in itself exposes SVG data if you want to play with it.

You can adjust the settings by viewing the detailed documentation.

4. Adding a diagram

In your markdown files add a code block with a mermaid descriptor like so:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Then you can run the build and you should see the image output in place of the mermaid markdown syntax.

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Viewing the documentation

The documentation can be found at https://docs.dpvreony.com/projects/docfx-mermaidjs/

Contributing to the code

See the contribution guidelines.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.1 907 4/17/2024
2.0.71 183 3/25/2024
2.0.62 253 3/7/2024
2.0.33 286 1/15/2024
2.0.30 128 1/12/2024
2.0.2 369 11/29/2023
2.0.1 166 11/28/2023
1.0.410 264 11/6/2023
1.0.386 201 10/20/2023
1.0.366 260 10/2/2023
1.0.315 461 8/26/2023
1.0.291 227 8/14/2023
1.0.275 198 8/4/2023
1.0.250 246 6/30/2023
1.0.224 258 6/12/2023
1.0.212 179 6/2/2023
1.0.198 192 5/24/2023
1.0.136 352 4/14/2023
1.0.122 284 4/7/2023
1.0.116 278 4/5/2023
1.0.110 230 4/3/2023
1.0.101 265 4/1/2023
1.0.99 240 3/31/2023
1.0.21 355 1/3/2023
1.0.19 328 1/3/2023

https://github.com/dpvreony/docfx-mermaidjs/releases