Markdown-Codeblock in C#

So erstellen Sie Markdown-Inline-Code oder -Codeblock in C#

Die Bibliothek Aspose.HTML for .NET ist eine eigenständige Lösung, mit der Sie Markdown-Dateien analysieren und bearbeiten können, ohne andere Software zu verwenden. Sie können ein Markdown-Dokument von Grund auf neu erstellen, aus einer lokalen Datei öffnen und bearbeiten, indem Sie neue Elemente einfügen, den Inhalt bestehender Knoten entfernen oder bearbeiten.
Verwenden Sie die Aspose.Html.Toolkit.Markdown.Syntax und Aspose.Html.Toolkit.Markdown.Parser Namespaces, um vollständiges Markdown-Parsing und MD-Syntaxbaumverwaltung basierend auf der GitHub Flavored Markdown (GFM)-Spezifikation bereitzustellen .

So fügen Sie Markdown-Inline-Code in C# hinzu

Mit der C#-Bibliothek können Sie MD-Dateien programmgesteuert bearbeiten – die Dokumentstruktur und den Inhalt ändern. Das Erstellen eines Markdown-Inline-Codes oder Markdown-Codeblocks in C# hat ein Feature, dass das CodeSpan- oder FencedCodeBlock-Element aus mehreren Knoten zusammengesetzt werden muss, wie z. B. Textknoten, Leerzeichen zwischen Textknoten oder einer leeren Zeile nach dem Knoten.
Sehen wir uns an, wie Sie ein Markdown-Dokument von Grund auf neu erstellen und Inline-Code hinzufügen.

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

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

    // Create an empty codeSpan node
    var codeSpan = mdf.CodeSpan();

    // Create text content for the codeSpan
    codeSpan.AppendChild(mdf.Text("Source code text"));

    // Add codeSpan to MD document
    markdown.AppendChild(codeSpan);

    // Add a space after the code node through a special WhiteSpace node
    markdown.AppendChild(mdf.Whitespace());

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

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

Schritte zum Erstellen von Markdown-Code in C#

Wir erinnern Sie daran, dass der Inline-Code aus den Komponentenknoten zusammengesetzt werden muss. Betrachten Sie einfache Schritte zum Erstellen von Markdown-Inline-Code:

1. Erstellen Sie einen neuen leeren CodeSpan-Knoten mit dem Konstruktor CodeSpan() in SyntaxFactory.
2. Verwenden Sie den Konstruktor Text(), um Textknoten für die CodeSpan zu erstellen.
3. Rufen Sie die AppendChild() -Methode der MarkdownSyntaxNode-Klasse auf, um Textknoten in die hinzuzufügen CodeSpan-Element.
4. Fügen Sie den erstellten Codeblock mit der Methode AppendChild() zum Syntaxbaum des Dokuments hinzu.
5. Verwenden Sie den Konstruktor Whitespace(), um Leerzeichen nach Inline-Code zu erstellen.

Markdown-Codeblock zur MD-Datei in C# hinzufügen

Das folgende C#-Codebeispiel zeigt, wie Sie einen Markdown-Codeblock zu einem MD-Dokument hinzufügen:

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

    // Create a Markdown syntax factory
    var mdf = markdown.SyntaxFactory;

    // Create a start token and an end token that will frame a code block
    var startToken = mdf.Token(SourceText.From("```\r\n"));
    var endToken = mdf.Token(SourceText.From("\r\n```"));

    // Create a fenced code element
    var fencedCodeSpan = mdf.FencedCodeBlock(startToken, null, endToken);

    // Create text content for the fenced code element
    fencedCodeSpan.AppendChild(mdf.Text("Source code text"));

    //Add the fenced code element to MD file
    markdown.AppendChild(fencedCodeSpan);

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

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

Dokumentation

Um mehr über die Aspose.HTML-API zu erfahren, besuchen Sie bitte unseren Dokumentation -Leitfaden. Markdown ist eine einfache Auszeichnungssprache, mit der Sie einfachen Text formatieren können. Der Dokumentationsartikel Markdown-Syntax enthält Informationen zu den wichtigsten Markdown-Elementen, Details und Beispielen der Markdown-Syntax.

Aspose.HTML for .NET installieren

Installieren Sie Aspose.HTML for .NET aus NuGet mit der .NET CLI:

dotnet add package Aspose.HTML

Alternativ können Sie die Benutzeroberfläche des NuGet-Paket-Managers verwenden oder Install-Package Aspose.HTML in der Paket-Manager-Konsole ausführen. Einzelheiten zur Einrichtung finden Sie in der Installationsanleitung . Mit einer temporären Lizenz können Sie die API ohne Einschränkungen der Evaluierung testen.

Systemanforderungen

Unsere APIs werden auf allen wichtigen Plattformen und Betriebssystemen unterstützt. Bevor Sie den Code ausführen, stellen Sie bitte sicher, dass die folgenden Voraussetzungen auf Ihrem System erfüllt sind.

• Microsoft Windows oder ein kompatibles Betriebssystem mit .NET Framework, .NET Core, Windows Azure, Mono oder Xamarin-Plattformen.
• Entwicklungsumgebung wie Microsoft Visual Studio.
• Aspose.HTML for .NET-DLL, auf die in Ihrem Projekt verwiesen wird – Installieren Sie von NuGet mithilfe der Download-Schaltfläche oben.