Markdown in C# bearbeiten

So bearbeiten Sie Markdown in C#

Die Bibliothek Aspose.HTML for .NET ist eine eigenständige Lösung, mit der Sie Markdown-Dateien ohne Verwendung anderer Software bearbeiten können. Sie können ein Markdown-Dokument ändern, indem Sie neue Elemente einfügen, den Inhalt bestehender Knoten entfernen oder bearbeiten.
Der Namensraum Aspose.Html.Toolkit.Markdown.Syntax enthält Klassen und Methoden zum Bearbeiten eines Markdown-Syntaxbaums auf GitHub Flavored Markdown (GFM) Specification.
Der Namespace Aspose.Html.Toolkit.Markdown.Parser enthält Klassen und Methoden, um eine vollständige Markdown-Analyse bereitzustellen und Rendern.
Der Namensraum Aspose.Html.Toolkit.Markdown.Extensions enthält Klassen und Methoden zur Bearbeitung des Markdown-Syntaxbaums auf Spezifikationen, die nicht Teil der GFM-Spezifikation sind.
Jede Dokumentbearbeitung, die Sie durchführen möchten, umfasst das Laden eines MD-Dokuments, das Bearbeiten und Speichern im unterstützten Format. Es können verschiedene Szenarien sein, aber es kann mit ein paar erforderlichen Schritten erstellt werden:

• Öffnen oder Markdown erstellen.
• Parse Markdown, um einen Syntaxbaum zu erhalten. Bearbeiten Sie die Markdown-Syntaxstruktur mithilfe der Klassen und Methoden in den obigen Namespaces.
• MD speichern oder MD konvertieren in das gewünschte Dateiformat.

So fügen Sie ein Element zu einer MD-Datei in C# hinzu

Mit der C#-Bibliothek können Sie MD-Dateien programmgesteuert bearbeiten – die Dokumentstruktur und den Inhalt ändern. Das folgende C#-Codebeispiel zeigt, wie Sie einem MD-Dokument einen neuen Absatz hinzufügen:

    // Specify the path to the source MD file
    var input = @"C:\temp\document.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 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("New paragraph text.");
    paragraphSyntaxNode.AppendChild(textSyntaxNode);

    // Add the paragraph 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-add-paragraph.md");

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

Schritte zum Erstellen und Hinzufügen von Elementen zum MD-Dokument in C#

Ziehen Sie einfache Schritte in Betracht, um ein vorhandenes MD-Dokument zu bearbeiten. Im Dokument wird ein neuer Textabsatz hinzugefügt:

1. Geben Sie den Pfad zur MD-Quelldatei an und verwenden Sie MarkdownParser() -Konstruktor, um eine neue Instanz der MarkdownParser-Klasse zu initialisieren.
2. Rufen Sie die Methode ParseFile() auf, um Markdown zu parsen und einen Syntaxbaum zu erhalten.
3. Verwenden Sie die Eigenschaft SyntaxFactory, um eine Syntaxfabrik zum Erstellen neuer Elemente zu erhalten.
4. Erstellen Sie mit dem Paragraph()-Konstruktor einen neuen Absatz. Textinhalt für einen neuen Absatz erstellen und hinzufügen.
5. Verwenden Sie die Methode InsertBefore(), um den Absatz vor dem ersten Element der Syntax hinzuzufügen Baum.
6. Speichern Sie die bearbeitete MD-Datei mit der Methode Save().

So bearbeiten Sie den Markdown-Header in C#

Sehen wir uns an, wie das erste Element in der MD-Datei ( document.md ) bearbeitet wird. Das erste Element in der Datei ist ein Header, Ebene 3. Die bearbeitete Datei finden Sie unter dem Link – output-edit-header.md

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

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

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

    // The first element of this document is AtxHeading
    var heading = (AtxHeadingSyntaxNode)syntaxTree.FirstChild;

    // Accumulate the text content from its elements
    var sb = new StringBuilder();

    while (heading.FirstChild != null)
    {
        sb.Append(heading.FirstChild);

        //  Remove accumulated first element from the tree
        heading.RemoveChild(heading.FirstChild);
    }

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

    // Сreate a text node consisting of new and old text and add it as a child element of AtxHeading 
    var textSyntaxNode = syntaxFactory.Text("Some new text! " + sb);

    // Add the new element to the document tree
    heading.AppendChild(textSyntaxNode);

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

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

Dokumentation

Um mehr über die Aspose.HTML-API zu erfahren, besuchen Sie bitte unseren Dokumentation -Leitfaden. Sie können die Beispiele aus dem Repository GitHub herunterladen. Sie sind Open Source und können in eigenen Anwendungen frei verwendet werden.

Der Dokumentationsartikel Markdown-Syntax enthält Informationen zu den wichtigsten Markdown-Elementen, Details und Beispielen der Markdown-Syntax.

Markdown ist eine einfache Auszeichnungssprache, mit der Sie einfachen Text formatieren können. MD-Dateien verwenden die von John Gruber vorgeschlagene und entwickelte Markdown-Sprache. John Gruber hat die Formatierungssyntax von Markdown mit dem Ziel entworfen, sie so lesbar wie möglich zu machen. Markdown wird häufig als Format für Dokumentationen und Readme-Dateien verwendet, da es das Schreiben in einem leicht lesbaren und leicht zu schreibenden Stil ermöglicht. Darüber hinaus können MD-Dateien in HTML, PDF, XPS oder Bilder konvertiert werden, um andere Formate für bestimmte Aufgaben zu nutzen.

FAQ

Erste Schritte mit der Aspose.HTML for .NET API

Es gibt mehrere Möglichkeiten, die Bibliothek Aspose.HTML for .NET auf Ihrem System zu installieren:

1. Installieren Sie ein NuGet-Paket mithilfe der NuGet Package Manager-GUI.
2. Installieren Sie ein NuGet-Paket mithilfe der Paket-Manager-Konsole.
3. Installieren Sie Aspose.HTML for .NET über MSI.
   

Diese Bibliothek unterstützt das Parsen von HTML5, CSS3, SVG und HTML Canvas, um ein Document Object Model (DOM) basierend auf dem WHATWG DOM-Standard zu erstellen. Aspose.HTML for .NET ist vollständig in C# geschrieben und kann verwendet werden, um jede Art von 32-Bit- oder 64-Bit-.NET-Anwendung zu erstellen, einschließlich ASP.NET, WCF, WinForms und .NET Core. Stellen Sie vor dem Ausführen des Beispielcodes für die .NET-Konvertierung sicher, dass Sie über ein Betriebssystem wie Microsoft Windows oder ein mit .NET Framework oder .NET Standard kompatibles Betriebssystem und eine Entwicklungsumgebung wie Microsoft Visual Studio verfügen. Weitere Einzelheiten zur Installation der C#-Bibliothek und zu den Systemanforderungen finden Sie in der Aspose.HTML-Dokumentation.