Markdig pour C# (.NET) : Guide complet

Markdig est un analyseur Markdown haute performance, entièrement géré pour la plateforme .NET, écrit en C#. Il offre aux développeurs un outil puissant et flexible pour convertir du texte Markdown en HTML, XAML et d'autres formats. Contrairement à de nombreuses autres bibliothèques, Markdig est conçu avec un accent sur la performance, l'extensibilité et une conformité stricte aux spécifications CommonMark. Cela en fait un choix idéal pour créer des systèmes de gestion de contenu, des blogs, des sites de documentation, des applications de chat et tout autre projet nécessitant le traitement de Markdown.

Pourquoi utiliser cette bibliothèque ? Dans le développement web moderne, Markdown est devenu le standard de facto pour la rédaction de documentation, d'articles et de messages. Cependant, pour l'afficher dans un navigateur, il faut le convertir en HTML. Markdig résout ce problème rapidement et efficacement. De plus, il prend en charge de nombreuses extensions telles que les tableaux, les notes de bas de page, le texte barré, les liens automatiques, les emojis (via des packages supplémentaires) et bien plus encore, allant au-delà du CommonMark de base. Vous pouvez facilement configurer le pipeline de traitement en n'activant que les extensions dont vous avez besoin, ce qui vous permet de contrôler à la fois les fonctionnalités et les performances.

Markdig est également réputé pour sa fiabilité. Il est activement utilisé dans des projets majeurs comme le générateur de sites statiques Statiq, la plateforme de documentation DocFX et bien d'autres. Grâce à son architecture modulaire, vous pouvez non seulement utiliser les extensions intégrées, mais aussi créer les vôtres, ouvrant ainsi des possibilités de personnalisation quasi illimitées. Dans cet article, nous allons détailler l'installation, les méthodes principales, fournir des exemples pratiques et donner des conseils pour une utilisation efficace de Markdig.

Installation

L'installation de Markdig dans un projet .NET se fait via le gestionnaire de packages NuGet. Vous pouvez utiliser la console du gestionnaire de packages, l'interface Visual Studio ou le .NET CLI. Les trois méthodes sont présentées ci-dessous.

Avec .NET CLI (recommandé) :

dotnet add package Markdig

Avec la console du gestionnaire de packages (Package Manager Console) :

Install-Package Markdig

Avec l'interface Visual Studio :
Ouvrez "Gérer les packages NuGet" (clic droit sur le projet -> Gérer les packages NuGet), recherchez "Markdig" et cliquez sur "Installer".

Après l'installation, une référence à l'assembly Markdig.dll sera ajoutée à votre projet et vous pourrez commencer à utiliser la bibliothèque.

Démarrage rapide

Commençons par l'exemple le plus simple : convertir une chaîne Markdown en HTML.

using Markdig;

string markdownContent = "# Bonjour le monde !\n\nCeci est du texte **gras** et *italique*.";
string htmlContent = Markdown.ToHtml(markdownContent);

Console.WriteLine(htmlContent);
// Sortie :
// <h1>Bonjour le monde !</h1>
// <p>Ceci est du texte <strong>gras</strong> et <em>italique</em>.</p>

Comme vous le voyez, c'est très simple. La méthode statique Markdown.ToHtml() fait tout le travail pour vous. Cependant, ce n'est que la partie émergée de l'iceberg. Nous allons maintenant explorer des fonctionnalités plus avancées.

Méthodes et classes principales

Pour un réglage plus fin du traitement Markdown, Markdig propose un ensemble de classes et de méthodes. Voici 8 éléments clés.

1. Markdown.ToHtml(string markdown)

Signature : public static string ToHtml(string markdown)

Fonction : Convertit une chaîne Markdown en chaîne HTML, en utilisant le pipeline standard avec les extensions CommonMark par défaut.

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