Markdown-Paragraph in C#

So erstellen Sie einen Markdown-Paragraph 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 einen Markdown-Paragraph in C# hinzu

Mit der C#-Bibliothek können Sie MD-Dateien programmgesteuert bearbeiten – die Dokumentstruktur und den Inhalt ändern. Das Erstellen eines MD-Absatzelements in C# hat eine Funktion. Das Merkmal ist, dass der Paragraph aus mehreren Knoten zusammengesetzt werden muss, wie z. B. Textknoten, Leerzeichen zwischen Textknoten und einer leeren Zeile nach dem Paragraph. Sehen wir uns an, wie Sie ein neues Markdown-Dokument von Grund auf neu erstellen und ihm zwei Absätze hinzufügen.

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

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

    // Add texts to the paragraph1
    paragraph1.AppendChild(mdf.Text("The first sentence of the first paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph1.AppendChild(mdf.Whitespace());

    paragraph1.AppendChild(mdf.Text("The second sentence of the first paragraph."));

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

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

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

    // Add texts to the paragraph2
    paragraph2.AppendChild(mdf.Text("The first sentence of the second paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph2.AppendChild(mdf.Whitespace());

    paragraph2.AppendChild(mdf.Text("The second sentence of the second paragraph."));

    // Add newLineTrivia element for an empty line after paragraph2
    paragraph2.GetTrailingTrivia().Add(newLineTrivia);

    // Add the filled paragraph2 into MD document as a last child
    md.AppendChild(paragraph2);

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

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

Schritte zum Erstellen von Markdown-Absätzen in C#

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

1. Erstellen Sie einen neuen leeren Absatzknoten mit dem Konstruktor Paragraph() in SyntaxFactory.
2. Verwenden Sie den Konstruktor Text(), um Textknoten für den Paragraph zu erstellen.
3. Rufen Sie die Methode AppendChild() der Klasse MarkdownSyntaxNode auf, um Textknoten und Leerzeichen hinzuzufügen in Paragraph.
4. Verwenden Sie den Konstruktor Whitespace() , um Leerzeichen zwischen Textknoten im Paragraph zu erstellen.
5. Erstellen und fügen Sie das newLineTrivia-Element für eine leere Zeile nach dem Paragraph hinzu. Verwenden Sie den Konstruktor NewLineTrivia() und die Add()-Methode.
6. Nachdem alle Absatzknoten zu einem Element zusammengefasst wurden, fügen Sie es dem Syntaxbaum des Dokuments hinzu.

Markdown-Paragraph zu vorhandener MD-Datei in C# hinzufügen

Das folgende C#-Codebeispiel zeigt, wie Sie einem vorhandenen MD-Dokument einen Paragraph hinzufügen:

    // 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 syntaxTree = parser.ParseFile(input);

    // Get a SyntaxFactory to create new elements
    var syntaxFactory = syntaxTree.SyntaxFactory;

    // Create a new empty paragraph 
    var paragraphSyntaxNode = syntaxFactory.Paragraph();

    // Create and add newLineTrivia element for an empty line after paragraph 
    var newLineTrivia = syntaxFactory.NewLineTrivia();
    paragraphSyntaxNode.GetTrailingTrivia().Add(newLineTrivia);

    // Create text content for the paragraph 
    var textSyntaxNode = syntaxFactory.Text("Markdown language is simple to learn. It has minimal extra characters, so you can quickly write and make fewer errors.");

    // Add text into paragraph
    paragraphSyntaxNode.AppendChild(textSyntaxNode);

    // Add paragraph to MD document before the first element of the syntax tree
    syntaxTree.InsertBefore(paragraphSyntaxNode, syntaxTree.FirstChild);

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

    // Save Markdown file
    syntaxTree.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.