Markdown-Text und Markdown-Blockquote in C#

So erstellen Sie Markdown-Text in C#

Markdown ist wie HTML eine Auszeichnungssprache. Im Gegensatz zu HTML zielt Markdown darauf ab, so gut wie möglich lesbar zu sein. Sie können den Text fett, kursiv, in Anführungszeichen und durchgestrichen darstellen. Sie können auch in Kombination verwendet werden, um mehrere Stile gleichzeitig zu verwenden. 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, es aus einer lokalen Datei öffnen und bearbeiten, indem Sie neue Elemente einfügen und den Inhalt bestehender Knoten entfernen oder bearbeiten.

Die Klasse MarkdownSyntaxFactory enthält Methoden zum Erstellen verschiedener Markdown-Elemente. Zur Erstellung von Headern können Sie die Methode AtxHeading() verwenden, die Atx-Überschriften erstellt Syntaxknoten mit Textinhalt. Sie können die Methode Emphasis() verwenden, die die Emphasis-Enumeration als Parameter verwendet Werte, um Text fett oder kursiv zu machen und mehr. Hier sehen wir uns einige C#-Beispiele für die Arbeit mit Markdown-Text an.

Markdown-Text in C#

Mit der C#-Bibliothek können Sie MD-Dateien programmgesteuert bearbeiten – die Dokumentstruktur und den Inhalt ändern. Sehen wir uns an, wie Sie ein neues Markdown-Dokument von Grund auf neu erstellen und ihm Texte 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;

    var header = mdf.AtxHeading("How to create Markdown Text in C#?", 2);

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

    // Add the  headers to the Markdown syntax tree
    md.AppendChild(header);

    // 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("Then create the Markdown Syntax Tree and 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, "markdown-text.md");

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

Schritte zum Erstellen von Markdown-Text in C#

Betrachten wir einige einfache Schritte zum Erstellen von Markdown-Texten:

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 einen neuen Header mit dem Konstruktor AtxHeading(string, int) von MarkdownSyntaxFactory -Klasse. Es erstellt AtxHeadingSyntaxNode mit Textinhalt und Überschriftenebene.
4. Erstellen Sie ein newLineTrivia-Element für eine leere Zeile nach der Kopfzeile. Verwenden Sie den Konstruktor NewLineTrivia().
5. Rufen Sie die Add()-Methode der SyntaxNodeCollection-Klasse auf, um den newLineTrivia-Knoten zum Header-Element hinzuzufügen.
6. Nachdem alle Header-Knoten zu einem Element zusammengefasst wurden, fügen Sie es dem Dokument-Syntaxbaum hinzu.
7. Erstellen Sie einen neuen leeren Absatzknoten mit dem Konstruktor Paragraph() in SyntaxFactory.
8. Verwenden Sie den Konstruktor Text(), um Textknoten für den Absatz zu erstellen.
9. Verwenden Sie den Konstruktor Whitespace() , um Leerzeichen zwischen Textknoten im Absatz zu erstellen.
10. Rufen Sie die Methode AppendChild() der Klasse MarkdownSyntaxNode auf, um Textknoten und Leerzeichen hinzuzufügen in Absatz.
11. Nachdem alle Absatzknoten zu einem Element zusammengefasst wurden, fügen Sie es dem Dokumentensyntaxbaum hinzu. Rufen Sie die Methode AppendChild() der Klasse MarkdownSyntaxNode auf.

Markdown-Blockquote in C# erstellen

Das folgende C#-Codebeispiel zeigt, wie Markdown-Blockquote erstellt wird.

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

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

    // Create a blockQuote object
    var blockQuote = mdf.BlockQuote();

    // Add a leading trivia token blockquote
    blockQuote.GetLinesLeadingTrivia().Add(mdf.Token(SourceText.From("> ")));

    // Create a paragraph with text content 
    var paragraph = mdf.Paragraph();
    paragraph.AppendChild(mdf.Text("For blockquote creation, you should put a sign `>` before the first line of a hard-wrapped paragraph.."));

    // Add paragraph into blockQuote
    blockQuote.AppendChild(paragraph);

    // Add blockQuote object into MD document
    markdown.AppendChild(blockQuote);

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "markdown-blockquote.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.

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.