如何在 C# 中创建 Markdown

Markdown 是一种简单的标记语言,可让您格式化纯文本。 Aspose.HTML for .NET 库是一个独立的解决方案,允许您在不使用其他软件的情况下解析和操作 Markdown 文件。您可以从头开始创建 Markdown 文档,从本地文件打开并通过插入新元素、删除或编辑现有节点的内容来进行操作。

Aspose.Html.Toolkit.Markdown.Syntax 命名空间包含用于操作基于 Markdown 语法树的类和方法在 GitHub Flavored Markdown (GFM) 规范上。

Aspose.Html.Toolkit.Markdown.Parser 命名空间包含提供完整 Markdown 解析的类和方法和渲染。

Aspose.Html.Toolkit.Markdown.Extensions 命名空间包含用于操作基于 Markdown 语法树的类和方法关于不属于 GFM 规范的规范。


如何在 C# 中从头开始创建 Markdown?

使用 C# 库,您可以以编程方式创建 MD 文件。让我们看看如何从头开始创建 Markdown。

C#代码创建MD文件

    // Create the MarkdownSyntaxTree
    var md = new MarkdownSyntaxTree(new Configuration());

    // Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree
    var mdf = md.SyntaxFactory;

    var heading2 = mdf.AtxHeading("How to create Markdown from scratch in C#?", 2);

    // Add the  headers to the Markdown syntax tree
    md.AppendChild(heading2);

    // Create and add newLineTrivia element for an empty line after heading1 
    var newLineTrivia = mdf.NewLineTrivia();
    heading2.GetTrailingTrivia().Add(newLineTrivia);

    // Create an empty paragraph
    var paragraph = mdf.Paragraph();

    // Add texts to the paragraph
    paragraph.AppendChild(mdf.Text("First, add an Aspose.HTML for .NET library reference to your C# project."));

    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph.AppendChild(mdf.Whitespace());

    paragraph.AppendChild(mdf.Text("Create the MarkdownSyntaxTree. Then use the SyntaxFactory property to get a syntax factory to create new elements."));

    // Add the filled paragraph into MD document
    md.AppendChild(paragraph);

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "document.md");

    // Save MD file
    md.Save(savePath);



在 C# 中创建 Markdown 的步骤

让我们来看看从头开始创建 Markdown 的简单步骤。前两个步骤是创建 Markdown 所必需的。接下来的步骤是添加新元素并保存文档:

  1. 使用 MarkdownSyntaxTree() 构造函数创建 MarkdownSyntaxTree。
  2. 使用 SyntaxFactory 属性获取用于创建 Markdown 语法树的工厂。
  3. 创建新元素并将其添加到 Markdown 文件中。
  4. 使用 Save() 方法保存创建的 MD 文件。

如何在 C# 中打开 MD 文件

以下 C# 代码示例显示了如何打开现有的 MD 文档:

C#打开MD文件的代码

    // Specify the path to the source MD file
    var input = "C:/temp/input.md";

    // Create a MarkdownParser object
    var parser = new MarkdownParser();

    // Parse the MD document and get a syntax tree
    var markdown = parser.ParseFile(input);

    // Work with Markdown document

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "input-edited.md");

    // Save MD file
    markdown.Save(savePath);

文档

要了解有关 Aspose.HTML API 的更多信息,请访问我们的 文档 指南。您可以从 GitHub 存储库下载示例。它们是开源的,可以在您自己的应用程序中自由使用。

Markdown 语法 文档文章提供了有关 Markdown 主要元素的信息、Markdown 语法的详细信息和示例。

MD 文件使用由 John Gruber 提出并开发的 Markdown 语言。约翰·格鲁伯 (John Gruber) 设计 Markdown 的格式化语法的目的是使其尽可能具有可读性。 Markdown 通常用作文档和自述文件的格式,因为它允许以易于阅读和易于编写的风格编写。此外,MD 文件可以转换为 HTML、PDF、XPS 或图像,以利用其他格式来完成特定任务。


FAQ

1. 如何在 C# 中创建、解析和编辑 Markdown?

用于 .NET 的 Aspose.HTML 库是一个独立的解决方案,用于处理不依赖于其他软件的 Markdown 文档。安装我们的 C# 库,将库引用添加到您的 C# 项目,并以编程方式处理 Markdown 文档

2. 为什么 Markdown 如此受欢迎?

由于其多功能性,Markdown 在作家、开发人员和内容创作者中非常受欢迎。 其优点包括易于学习和使用的语法、可移植性、灵活性、可读性和可用性。 Markdown 简单直观,可以转换为 HTML、PDF 或其他格式。

3. 我可以在 Linux、Mac OS、Android 或 iOS 上使用 Markdown 文件吗?

您可以在任何操作系统上使用 Markdown 文档,无论您使用的是 Windows、Mac OS、Linux、Android 还是 iOS。

4. Aspose.HTML C#库可以处理哪些文件格式?

我们支持多种文件格式,您可以在 C# 中创建、打开、解析、编辑、保存或转换它们。这些是 HTML、XHTML、MHTML 和 Markdown 格式。



.NET HTML API 入门

您可以使用多种方式在您的系统上安装适用于 .NET 的 Aspose.HTML 库:

  1. 使用 NuGet 包管理器 GUI 安装 NuGet 包
  2. 使用包管理器控制台安装 NuGet 包。
  3. 通过 MSI 安装 Aspose.HTML for .NET。

该库支持解析 HTML5、CSS3、SVG 和 HTML Canvas,以构建基于 WHATWG DOM 标准的文档对象模型 (DOM)。 Aspose.HTML for .NET 完全用 C# 编写,可用于构建任何类型的 32 位或 64 位 .NET 应用程序,包括 ASP.NET、WCF、WinForms 和 .NET Core。在运行 .NET 转换示例代码之前,请确保您拥有 Microsoft Windows 等操作系统或与 .NET Framework 或 .NET Standard 兼容的操作系统,以及 Microsoft Visual Studio 等开发环境。有关 C# 库安装和系统要求的更多详细信息,请参阅 Aspose.HTML 文档

系统要求

所有主要平台和操作系统都支持我们的 API。在执行代码之前,请确保您的系统具备以下先决条件。

  • Microsoft Windows 或具有 .NET Framework、.NET Core、Windows Azure、Mono 或 Xamarin 平台的兼容操作系统。
  • Microsoft Visual Studio 等开发环境。
  • Aspose.Html for .NET DLL 在您的项目中引用 – 使用上面的下载按钮从 NuGet 安装。