Dhgms.DocFx.MermaidJs.Plugin 1.0.315

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

• https://dotnet.github.io/docfx/
• https://mermaid.js.org/
• https://github.com/mermaid-js/mermaid-cli
• https://github.com/mermaid-js/mermaid
• https://github.com/dpvreony/article-statiq-mermaid
• https://github.com/KevReed/DocFx.Plugins.PlantUml

Getting Started

v2 of this plug in only supports MarkDig, due to DocFx 2.60 deprecating support for DFM. The plug in model is significantly different in v2.60 as well and requires you to have your own application to run the DocFX generation.

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:

• Currently only HTML generation is supported, PDF is not supported due to a breaking change in DocFX 2.60 which I'm looking to resolve with a PR.
• 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://dpvreony.github.io/docfx-mermaidjs/

Contributing to the code

See the contribution guidelines.