Markdig 用于 C# (.NET)：完整指南

\n\n

Markdig 是一个高性能、完全托管的 Markdown 解析器，适用于 .NET 平台，使用 C# 编写。它为开发者提供了强大且灵活的工具，用于将 Markdown 文本转换为 HTML、XAML 及其他格式。与许多其他库不同，Markdig 的设计注重性能、可扩展性，并严格遵守 CommonMark 规范。这使其成为构建内容管理系统、博客、文档网站、聊天应用以及任何需要处理 Markdown 的项目的理想选择。

\n\n

为什么需要这个库？在现代 Web 开发中，Markdown 已成为编写文档、文章和消息的事实标准。然而，要在浏览器中显示它，必须将其转换为 HTML。Markdig 快速高效地解决了这个问题。此外，它还支持多种扩展，例如表格、脚注、删除线、自动链接、表情符号（通过附加包）等，这些功能超出了基础 CommonMark 的范围。您可以轻松配置处理管道，仅添加所需的扩展，从而控制功能性和性能。

\n\n

Markdig 还以其可靠性著称。它被广泛应用于大型项目中，例如静态网站生成器 Statiq、文档平台 DocFX 等。得益于其模块化架构，您不仅可以使用内置扩展，还可以创建自己的扩展，这为定制化提供了几乎无限的可能性。在本文中，我们将详细介绍安装、主要方法，提供实用示例，并给出有效使用 Markdig 的建议。

\n\n

安装

\n\n

通过 NuGet 包管理器将 Markdig 安装到 .NET 项目中。您可以使用包管理器控制台、Visual Studio 界面或 .NET CLI。以下是三种方法。

\n\n

通过 .NET CLI（推荐）：

\n

dotnet add package Markdig

\n\n

通过包管理器控制台：

\n

Install-Package Markdig

\n\n

通过 Visual Studio 界面：
\n打开“管理 NuGet 包”（右键单击项目 -> 管理 NuGet 包），搜索“Markdig”并点击“安装”。

\n\n

安装后，您的项目将添加对 Markdig.dll 程序集的引用，然后即可开始使用该库。

\n\n

快速入门

\n\n

让我们从一个最简单的示例开始：将 Markdown 字符串转换为 HTML。

\n\n

using Markdig;\n\nstring markdownContent = "# 你好，世界！\\n\\n这是**粗体**文本和*斜体*。";\nstring htmlContent = Markdown.ToHtml(markdownContent);\n\nConsole.WriteLine(htmlContent);\n// 输出：\n// <h1>你好，世界！</h1>\n// <p>这是 <strong>粗体</strong> 文本和 <em>斜体</em>。</p>\n

\n\n

如您所见，非常简单。静态方法 Markdown.ToHtml() 为您完成了所有工作。然而，这只是冰山一角。接下来，我们将探讨更高级的功能。

\n\n

主要方法和类

\n\n

为了更精细地配置 Markdown 处理，Markdig 提供了一组类和方法。以下是 8 个关键方法。

\n\n

1. Markdown.ToHtml(string markdown)

\n

签名： public static string ToHtml(string markdown)

\n

功能： 使用默认管道（Pipeline）及 CommonMark 扩展，将 Markdown 字符串转换为 HTML 字符串。

\n

string html = Markdown.ToHtml("**Hello** *World*");\nConsole.WriteLine(html); // <p>