Ociaw.StatiqMermaid 0.1.0-beta.2

This is a prerelease version of Ociaw.StatiqMermaid.

dotnet add package Ociaw.StatiqMermaid --version 0.1.0-beta.2

NuGet\Install-Package Ociaw.StatiqMermaid -Version 0.1.0-beta.2

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="Ociaw.StatiqMermaid" Version="0.1.0-beta.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Ociaw.StatiqMermaid --version 0.1.0-beta.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Ociaw.StatiqMermaid, 0.1.0-beta.2"

#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 Ociaw.StatiqMermaid as a Cake Addin
#addin nuget:?package=Ociaw.StatiqMermaid&version=0.1.0-beta.2&prerelease

// Install Ociaw.StatiqMermaid as a Cake Tool
#tool nuget:?package=Ociaw.StatiqMermaid&version=0.1.0-beta.2&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

StatiqMermaid

Provides Statiq modules and a pipeline to generate diagrams from code. Depends upon Mermaid CLI.

Modules added:

BuildMermaidDefinition - builds a mermaid definition from API pipeline results
RenderMermaidSvg - renders an SVG from mermaid definition (.mmd) documents
RenderMermaidSvgInsideHtml - renders and embeds SVGs from HTML documents
RenderMermadModule - base class for mermaid modules, useful if building your own module
TplParallelModule - base class for modules that can run in parallel, but need to limit the degree

The Mermaid Pipeline inserts itself to execute after the "API" pipeline, but before the "Content" pipeline. It pulls documents API that have the Kind of NamedType, then feeds them to BuildMermaidDefinition and RenderMermaidSvg, respectively, before writing the resulting SVGs to the file system.

Usage

Adding the pipeline:

using Ociaw.StatiqMermaid;

await Bootstrapper.Factory
    .CreateDocs(args)
    .AddSourceFiles(sourceGlob)
    .AddPipeline("Mermaid", new Mermaid())
    .RunAsync();

Mermaid CLI must be installed; StatiqMermaid has been built against Version 10.0.0.

Settings

The following settings are used to configure the behavior of StatiqMermaid:

MermaidExecutable: string - the path to the mermaid CLI executable; defaults to "mmdc" or "mmdc.cmd" on Windows.
MermaidTimeoutSec: int - the number of seconds allowed for Mermaid CLI to render a single diagram before cancelling; defaults to 120
MaxDegreeOfParallelism: int - the maximum number of CLI executions to run in parallel; defaults to Environment.ProcessorCount

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Statiq.CodeAnalysis (>= 1.0.0-beta.64)
- Statiq.Core (>= 1.0.0-beta.64)

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
0.1.0-beta.2	147	3/5/2023
0.1.0-beta.1	129	12/24/2022