Markdown in C# erstellen

So erstellen Sie Markdown in C#

Markdown ist eine einfache Auszeichnungssprache, mit der Sie einfachen Text formatieren können. 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.
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.

Wie erstelle ich Markdown von Grund auf neu in C#?

Mit der C#-Bibliothek können Sie MD-Dateien programmgesteuert erstellen. Schauen wir uns an, wie man Markdown von Grund auf neu erstellt.

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

Schritte zum Erstellen von Markdown in C#

Werfen wir einen Blick auf die einfachen Schritte zum Erstellen von Markdown von Grund auf. Die ersten beiden Schritte sind für die Erstellung von Markdown zwingend erforderlich. Die nächsten Schritte sind das Hinzufügen neuer Elemente und das Speichern des Dokuments:

1. Erstellen Sie den MarkdownSyntaxTree mit dem Konstruktor MarkdownSyntaxTree().
2. Verwenden Sie die Eigenschaft SyntaxFactory, um die Factory zum Erstellen des Markdown-Syntaxbaums abzurufen.
3. Erstellen Sie neue Elemente und fügen Sie sie einer Markdown-Datei hinzu.
4. Speichern Sie die erstellte MD-Datei mit der Methode Save().

So öffnen Sie eine MD-Datei in C#

Das folgende C#-Codebeispiel zeigt, wie ein vorhandenes MD-Dokument geöffnet wird:

    // 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, "output.md");

    // Save MD file
    markdown.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.

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 .NET-HTML-API

Sie haben mehrere Möglichkeiten, die Aspose.HTML-Bibliothek für .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 für .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 für .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 für .NET-DLL, auf die in Ihrem Projekt verwiesen wird – Installieren Sie von NuGet mithilfe der Download-Schaltfläche oben.