Markdig 使用教程

Markdig 使用教程

markdigA fast, powerful, CommonMark compliant, extensible Markdown processor for .NET项目地址:https://gitcode.com/gh_mirrors/ma/markdig

项目介绍

Markdig 是一个快速、强大且符合 CommonMark 标准的 .NET Markdown 处理器。它支持多种扩展，如语法高亮、脚本嵌入、图表生成等，适用于需要高性能 Markdown 解析和渲染的场景。

项目快速启动

安装

首先，通过 NuGet 安装 Markdig：

dotnet add package Markdig

基本使用

以下是一个简单的示例，展示如何使用 Markdig 解析和渲染 Markdown 内容：

using Markdig;

class Program
{
    static void Main()
    {
        var markdown = "# Hello, Markdig!";
        var result = Markdig.Markdown.ToHtml(markdown);
        Console.WriteLine(result); // 输出: <h1>Hello, Markdig!</h1>
    }
}

应用案例和最佳实践

语法高亮

Markdig 支持多种语法高亮扩展，如使用 ColorCode 或 Prism.js。以下是一个使用 ColorCode 的示例：

var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    .UseSyntaxHighlighting()
    .Build();

var markdown = "```csharp\npublic void Main() {}\n```";
var result = Markdig.Markdown.ToHtml(markdown, pipeline);
Console.WriteLine(result);

图表生成

Markdig 支持 Mermaid 和 Nomnoml 等图表生成工具。以下是一个使用 Mermaid 的示例：

var pipeline = new MarkdownPipelineBuilder()
    .UseDiagrams()
    .Build();

var markdown = "```mermaid\ngraph TD;\nA-->B;\n```";
var result = Markdig.Markdown.ToHtml(markdown, pipeline);
Console.WriteLine(result);

典型生态项目

Markdig.Wpf

Markdig.Wpf 是一个基于 Markdig 的 WPF Markdown 渲染器，适用于在 WPF 应用中渲染 Markdown 内容。

Markdig.SyntaxHighlighting

Markdig.SyntaxHighlighting 是一个语法高亮扩展，支持多种编程语言的语法高亮显示。

Markdig.Extensions.ScriptCs

Markdig.Extensions.ScriptCs 允许在 Markdown 文档中嵌入 C# 脚本，扩展了 Markdig 的功能。

通过以上模块的介绍和示例，您可以快速上手并深入了解 Markdig 的使用和扩展。

markdigA fast, powerful, CommonMark compliant, extensible Markdown processor for .NET项目地址:https://gitcode.com/gh_mirrors/ma/markdig