Markdig für C# (.NET): Vollständige Anleitung

Markdig ist ein leistungsstarker, vollständig verwalteter Markdown-Parser für die .NET-Plattform, geschrieben in C#. Er bietet Entwicklern ein flexibles und effizientes Werkzeug, um Markdown-Text in HTML, XAML und andere Formate zu konvertieren. Im Gegensatz zu vielen anderen Bibliotheken wurde Markdig mit Fokus auf Performance, Erweiterbarkeit und strikter Einhaltung der CommonMark-Spezifikation entwickelt. Das macht ihn zur idealen Wahl für Content-Management-Systeme, Blogs, Dokumentationsseiten, Chat-Anwendungen und alle anderen Projekte, die Markdown verarbeiten müssen.

Warum braucht man diese Bibliothek? In der modernen Webentwicklung ist Markdown zum De-facto-Standard für Dokumentationen, Artikel und Nachrichten geworden. Um ihn im Browser darzustellen, muss er jedoch in HTML umgewandelt werden. Markdig erledigt diese Aufgabe schnell und effizient. Darüber hinaus unterstützt er zahlreiche Erweiterungen wie Tabellen, Fußnoten, durchgestrichenen Text, automatische Links, Emojis (über zusätzliche Pakete) und vieles mehr, das über die grundlegenden CommonMark-Funktionen hinausgeht. Sie können die Verarbeitungspipeline einfach anpassen, indem Sie nur die benötigten Erweiterungen hinzufügen – das gibt Ihnen die volle Kontrolle über Funktionalität und Performance.

Markdig ist auch für seine Zuverlässigkeit bekannt. Er wird in großen Projekten wie dem Static-Site-Generator Statiq, der Dokumentationsplattform DocFX und vielen anderen aktiv eingesetzt. Dank der modularen Architektur können Sie nicht nur die integrierten Erweiterungen nutzen, sondern auch eigene erstellen – das eröffnet nahezu unbegrenzte Möglichkeiten zur Anpassung. In diesem Artikel gehen wir detailliert auf die Installation, die wichtigsten Methoden ein, zeigen praktische Beispiele und geben Tipps zur effektiven Nutzung von Markdig.

Installation

Die Installation von Markdig in ein .NET-Projekt erfolgt über den NuGet-Paketmanager. Sie können die Paketmanager-Konsole, die Visual Studio-Oberfläche oder die .NET CLI verwenden. Nachfolgend finden Sie alle drei Möglichkeiten.

Über die .NET CLI (empfohlen):

dotnet add package Markdig

Über die Paketmanager-Konsole (Package Manager Console):

Install-Package Markdig

Über die Visual Studio-Oberfläche:
Öffnen Sie "NuGet-Pakete verwalten" (Rechtsklick auf das Projekt -> NuGet-Pakete verwalten), suchen Sie nach "Markdig" und klicken Sie auf "Installieren".

Nach der Installation wird Ihrem Projekt ein Verweis auf die Assembly Markdig.dll hinzugefügt, und Sie können die Bibliothek sofort nutzen.

Schnellstart

Beginnen wir mit einem einfachen Beispiel: Wir konvertieren einen Markdown-String in HTML.

using Markdig;

string markdownContent = "# Hallo Welt!\n\nDas ist **fetter** Text und *kursiver* Text.";
string htmlContent = Markdown.ToHtml(markdownContent);

Console.WriteLine(htmlContent);
// Ausgabe:
// <h1>Hallo Welt!</h1>
// <p>Das ist <strong>fetter</strong> Text und <em>kursiver</em> Text.</p>

Wie Sie sehen, ist es ganz einfach. Die statische Methode Markdown.ToHtml() erledigt die gesamte Arbeit für Sie. Das ist jedoch nur die Spitze des Eisbergs. Im Folgenden betrachten wir fortgeschrittenere Funktionen.

Wichtige Methoden und Klassen

Für eine feinere Steuerung der Markdown-Verarbeitung bietet Markdig eine Reihe von Klassen und Methoden. Hier sind 8 der wichtigsten.

1. Markdown.ToHtml(string markdown)

Signatur: public static string ToHtml(string markdown)

Funktion: Konvertiert einen Markdown-String in einen HTML-String unter Verwendung der Standard-Pipeline mit den Standard-CommonMark-Erweiterungen.

string html = Markdown.ToHtml("**Hallo** *Welt*");
Console.WriteLine(html); // <p><strong>Hallo</strong> <em>Welt</em></p>