Dhgms.DocFx.MermaidJs.Plugin 3.0.1

.NET 8.0

dotnet add package Dhgms.DocFx.MermaidJs.Plugin --version 3.0.1

NuGet\Install-Package Dhgms.DocFx.MermaidJs.Plugin -Version 3.0.1

该命令旨在在 Visual Studio 的包管理器控制台中使用，因为它使用 NuGet 模块的Install-Package版本。

<PackageReference Include="Dhgms.DocFx.MermaidJs.Plugin" Version="3.0.1" />

对于支持PackageReference的项目，将此 XML 节点复制到项目文件中以引用包。

paket add Dhgms.DocFx.MermaidJs.Plugin --version 3.0.1

NuGet 团队不为此客户端提供支持。请联系其管理员以获得支持。

#r "nuget: Dhgms.DocFx.MermaidJs.Plugin, 3.0.1"

#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将此复制到交互式工具或脚本的源代码中以引用包。

// 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

NuGet 团队不为此客户端提供支持。请联系其管理员以获得支持。

DocFx MermaidJS

使命宣言

在 DocFX 项目的构建过程中提供将 MermaidJS 符号转换为图表的插件。

简介

此 DocFX MermaidJS 插件是 mermaid NPM 包的包装程序。其目的是在构建时生成 mermaid 图表，因此

可以在构建时验证语法。
图像仅构建一次。
图像可以嵌入在 PDF 中。

鸣谢

开始使用

1. 创建控制台应用程序（或类似的应用程序）

2. 在您的 docfx_project 中添加对 "Dhgms.DocFX.Mermaid.Plugin" 的 NuGet 包引用

3. 添加以下初始化

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

您可以在以下示例中查看此示例：

注意

仅支持内联 PNG 图像，这由于插件模型和动态添加文件到文件缓存的限制。我可能会在将来重新考虑此问题。如果需要处理，插件本身提供 SVG 数据。

您可以通过查看详细文档来调整设置。

4. 添加图表

在您的 markdown 文件中添加一个代码块，其中包含类似于以下内容的 mermaid 描述符：

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

然后您可以运行构建，应该会看到替代mermaid markdown语法的图像输出。

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

查看文档

文档可以在https://docs.dpvreony.com/projects/docfx-mermaidjs/找到

为代码做出贡献

请参阅贡献指南。

产品	兼容和额外的计算目标框架版本。
.NET	net8.0 兼容。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。

兼容目标框架

包含目标框架（在包中）

了解更多关于目标框架和 .NET 标准的信息。

net8.0
- Microsoft.AspNetCore.Mvc.Testing (>= 8.0.4)
- Microsoft.DocAsCode.MarkdigEngine.Extensions (>= 2.67.5)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Microsoft.Playwright (>= 1.43.0)
- Nito.AsyncEx (>= 5.1.2)
- System.Reactive (>= 6.0.0)

NuGet 包

此包未被任何 NuGet 包使用。

GitHub 仓库

此包未使用任何流行的 GitHub 仓库。

版本	下载	最后更新
3.0.1	442	4/17/2024
2.0.71	171	3/25/2024
2.0.62	227	3/7/2024
2.0.33	261	1/15/2024
2.0.30	112	1/12/2024
2.0.2	348	11/29/2023
2.0.1	145	11/28/2023
1.0.410	244	11/6/2023
1.0.386	195	10/20/2023
1.0.366	231	10/2/2023
1.0.315	439	8/26/2023
1.0.291	202	8/14/2023
1.0.275	178	8/4/2023
1.0.250	223	6/30/2023
1.0.224	227	6/12/2023
1.0.212	154	6/2/2023
1.0.198	176	5/24/2023
1.0.136	331	4/14/2023
1.0.122	257	4/7/2023
1.0.116	248	4/5/2023
1.0.110	208	4/3/2023
1.0.101	245	4/1/2023
1.0.99	216	3/31/2023
1.0.21	336	1/3/2023
1.0.19	306	1/3/2023

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