Traitement Markdown en C# (.NET) : bibliothèques et outils

Travailler avec Markdown en C# (.NET) : aperçu des bibliothèques et outils

\n\n

Markdown est un langage de balisage léger largement utilisé pour formater du texte dans la documentation, les fichiers README, les blogs et les chats. Dans l'écosystème C# (.NET), il existe plusieurs bibliothèques puissantes qui permettent d'analyser, de traiter et de convertir Markdown en HTML et en d'autres formats. Dans cet article, nous examinerons les outils les plus populaires, leurs fonctionnalités et des exemples d'utilisation.

\n\n

Pourquoi traiter Markdown en C# ?

\n\n

Les applications web modernes, les systèmes de gestion de contenu (CMS) et les éditeurs de code utilisent de plus en plus Markdown comme format de saisie principal. En C# (.NET), cela peut être utile pour :

\n

\n
• Générer du contenu statique (documentation, blogs)
\n
• Implémenter des éditeurs WYSIWYG avec prise en charge Markdown
\n
• Importer/exporter des données depuis des systèmes externes (GitHub, Reddit, Stack Overflow)
\n
• Convertir Markdown en PDF, DOCX ou LaTeX via un HTML intermédiaire
\n

\n\n

Bibliothèques principales pour C# (.NET)

\n\n

1. Markdig

\n

Markdig est la bibliothèque la plus populaire et la plus performante pour travailler avec Markdown dans .NET. Elle prend en charge CommonMark, GFM (GitHub Flavored Markdown) et de nombreuses extensions : tableaux, listes de tâches, remplacement automatique de liens, formules mathématiques (via MathJax) et bien plus encore.

\n\n

Installation :

\n

// Via NuGet Package Manager\nInstall-Package Markdig\n\n// Ou via .NET CLI\ndotnet add package Markdig

\n\n

Exemple d'utilisation :

\n

using Markdig;\n\nstring markdown = @"\n# Titre de premier niveau\n\n**Texte en gras** et *italique*.\n\n- Élément de liste 1\n- Élément de liste 2\n\n> Citation\n\n```csharp\nConsole.WriteLine(""Hello, World!"");\n```";\n\n// Conversion en HTML avec les extensions GFM\nstring html = Markdown.ToHtml(markdown);\n\nConsole.WriteLine(html);\n

\n\n

Fonctionnalités avancées :

\n

// Configuration du pipeline avec des extensions supplémentaires\nvar pipeline = new MarkdownPipelineBuilder()\n    .UseAdvancedExtensions() // Inclut toutes les extensions populaires\n    .UseMathematics()        // Prise en charge des formules LaTeX\n    .UseEmojiAndSmiley()     // Émojis :smile:\n    .Build();\n\nstring htmlWithExtensions = Markdown.ToHtml(markdown, pipeline);\n

\n\n

2. CommonMark.NET

\n

CommonMark.NET est une implémentation stricte de la spécification CommonMark (standard Markdown). La bibliothèque est légère, sans dépendances et idéale pour les projets où la compatibilité avec l'implémentation de référence est importante.

\n\n

Installation :

\n

Install-Package CommonMark.NET

\n\n

Exemple d'utilisation :

\n

using CommonMark;\n\nstring markdown = "Bonjour, **monde**!";\nstring html = CommonMarkConverter.Convert(markdown);\n\n// Résultat : <p>Bonjour, <strong>monde</strong>!</p>\n

\n\n

3. MarkdownSharp

\n

MarkdownSharp est un port du processeur Markdown original en C# par Jeff Atwood (co-fondateur de Stack Overflow). La bibliothèque est obsolète mais encore utilisée dans d'anciens projets. Elle ne prend en charge que la syntaxe de base sans extensions.

\n\n

Install-Package MarkdownSharp

\n\n

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

\n\n

Outils supplémentaires

\n\n

4. HtmlSanitizer (pour un affichage sécurisé)

\n

Lors de la conversion de Markdown en HTML et de son affichage ultérieur sur une page web, il est important de nettoyer le résultat des balises potentiellement dangereuses (attaques XSS). Utilisez la bibliothèque 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