Markdown-Header in C#

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

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

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

    // Get a SyntaxFactory to create new elements
    var mdf = markdown.SyntaxFactory;

    // Create headings of the required level
    var heading1 = mdf.AtxHeading("Heading 1 level text", 1);
    var heading2 = mdf.AtxHeading("Heading 2 level text", 2);
    var heading3 = mdf.AtxHeading("Heading 3 level text", 3);

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

    // Add the headers to the Markdown syntax tree
    markdown.AppendChild(heading1);
    markdown.AppendChild(heading2);
    markdown.AppendChild(heading3);

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

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

Schritte zum Erstellen eines Markdown-Headers in C#

Betrachten wir die einfachen Schritte zum Erstellen eines Markdown-Headers:

1. Erstellen Sie einen neuen Header mit dem Konstruktor AtxHeading(string, int) von MarkdownSyntaxFactory -Klasse. Es erstellt AtxHeadingSyntaxNode mit Textinhalt und Überschriftenebene.
2. Erstellen Sie ein newLineTrivia-Element für eine leere Zeile nach der Kopfzeile. Verwenden Sie den Konstruktor NewLineTrivia().
3. Rufen Sie die Add()-Methode der SyntaxNodeCollection-Klasse auf, um den newLineTrivia-Knoten zum Header-Element hinzuzufügen.
4. Nachdem alle Header-Knoten zu einem Element zusammengefasst wurden, fügen Sie es dem Dokument-Syntaxbaum hinzu.

Bearbeiten Sie den Markdown-Header in einer vorhandenen MD-Datei in C#

Das folgende C#-Codebeispiel zeigt, wie Markdown-Header in einem vorhandenen MD-Dokument bearbeitet werden:

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

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

    // Parse the document and get a Markdown 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("Added 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, "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. 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.

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.

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.