Markdown-Verarbeitung in C# (.NET): Bibliotheken und Werkzeuge

Arbeiten mit Markdown in C# (.NET): Überblick über Bibliotheken und Werkzeuge

\n\n

Markdown ist eine leichtgewichtige Auszeichnungssprache, die häufig zur Textformatierung in Dokumentationen, README-Dateien, Blogs und Chats verwendet wird. Im C# (.NET)-Ökosystem gibt es mehrere leistungsstarke Bibliotheken, mit denen Sie Markdown parsen, verarbeiten und in HTML und andere Formate konvertieren können. In diesem Artikel betrachten wir die beliebtesten Werkzeuge, ihre Funktionen und Anwendungsbeispiele.

\n\n

Warum ist die Markdown-Verarbeitung in C# wichtig?

\n\n

Moderne Webanwendungen, Content-Management-Systeme (CMS) und Code-Editoren verwenden zunehmend Markdown als primäres Eingabeformat. In C# (.NET) kann dies nützlich sein für:

\n

\n
• Generierung statischer Inhalte (Dokumentation, Blogs)
\n
• Implementierung von WYSIWYG-Editoren mit Markdown-Unterstützung
\n
• Import/Export von Daten aus externen Systemen (GitHub, Reddit, Stack Overflow)
\n
• Konvertierung von Markdown in PDF, DOCX oder LaTeX über zwischengeschaltetes HTML
\n

\n\n

Wichtige Bibliotheken für C# (.NET)

\n\n

1. Markdig

\n

Markdig ist die beliebteste und leistungsfähigste Bibliothek für die Arbeit mit Markdown in .NET. Sie unterstützt CommonMark, GFM (GitHub Flavored Markdown) und zahlreiche Erweiterungen: Tabellen, Aufgabenlisten, automatische Linkersetzung, mathematische Formeln (über MathJax) und vieles mehr.

\n\n

Installation:

\n

// Über NuGet Package Manager\nInstall-Package Markdig\n\n// Oder über .NET CLI\ndotnet add package Markdig

\n\n

Anwendungsbeispiel:

\n

using Markdig;\n\nstring markdown = @"\n# Überschrift erster Ebene\n\n**Fetter Text** und *kursiver Text*.\n\n- Listenelement 1\n- Listenelement 2\n\n> Zitat\n\n```csharp\nConsole.WriteLine(""Hello, World!"");\n```";\n\n// Konvertierung in HTML mit GFM-Erweiterungen\nstring html = Markdown.ToHtml(markdown);\n\nConsole.WriteLine(html);\n

\n\n

Erweiterte Funktionen:

\n

// Konfiguration einer Pipeline mit zusätzlichen Erweiterungen\nvar pipeline = new MarkdownPipelineBuilder()\n    .UseAdvancedExtensions() // Aktiviert alle gängigen Erweiterungen\n    .UseMathematics()        // Unterstützung für LaTeX-Formeln\n    .UseEmojiAndSmiley()     // Emojis :smile:\n    .Build();\n\nstring htmlWithExtensions = Markdown.ToHtml(markdown, pipeline);\n

\n\n

2. CommonMark.NET

\n

CommonMark.NET ist eine strenge Implementierung der CommonMark-Spezifikation (Markdown-Standard). Die Bibliothek ist leichtgewichtig, hat keine Abhängigkeiten und ist ideal für Projekte, bei denen die Kompatibilität mit der Referenzimplementierung wichtig ist.

\n\n

Installation:

\n

Install-Package CommonMark.NET

\n\n

Anwendungsbeispiel:

\n

using CommonMark;\n\nstring markdown = "Hallo, **Welt**!";\nstring html = CommonMarkConverter.Convert(markdown);\n\n// Ergebnis: <p>Hallo, <strong>Welt</strong>!</p>\n

\n\n

3. MarkdownSharp

\n

MarkdownSharp ist ein Port des ursprünglichen Markdown-Prozessors in C# von Jeff Atwood (Mitbegründer von Stack Overflow). Die Bibliothek ist veraltet, wird aber immer noch in älteren Projekten verwendet. Sie unterstützt nur die grundlegende Syntax ohne Erweiterungen.

\n\n

Install-Package MarkdownSharp

\n\n

using MarkdownSharp;\n\nvar markdown = new Markdown();\nstring html = markdown.Transform("**Hallo**");\n

\n\n

Zusätzliche Werkzeuge

\n\n

4. HtmlSanitizer (für sichere Ausgabe)

\n

Bei der Konvertierung von Markdown in HTML und der anschließenden Ausgabe auf einer Webseite ist es wichtig, das Ergebnis von potenziell gefährlichen Tags (XSS-Angriffe) zu bereinigen. Verwenden Sie die Bibliothek HtmlSanitizer:

\n\n

Install-Package HtmlSanitizer\n\nusing Ganss.XSS;\n\nvar sanitizer = new HtmlSanitizer();\nstring rawHtml = Markdown.ToHtml("<script>alert('xss')</script>");\nstring safeHtml = sanit