Markdig para C# (.NET): Guia Completo

Markdig é um parser Markdown de alto desempenho e totalmente gerenciado para a plataforma .NET, escrito em C#. Ele oferece aos desenvolvedores uma ferramenta poderosa e flexível para converter texto Markdown em HTML, XAML e outros formatos. Diferente de muitas outras bibliotecas, o Markdig foi projetado com foco em desempenho, extensibilidade e conformidade rigorosa com as especificações CommonMark. Isso o torna a escolha ideal para criar sistemas de gerenciamento de conteúdo, blogs, sites de documentação, aplicativos de chat e qualquer outro projeto que exija processamento de Markdown.

Por que usar esta biblioteca? No desenvolvimento web moderno, o Markdown se tornou o padrão de facto para escrever documentação, artigos e mensagens. No entanto, para exibi-lo no navegador, é necessário convertê-lo para HTML. O Markdig resolve essa tarefa de forma rápida e eficiente. Além disso, ele suporta diversas extensões, como tabelas, notas de rodapé, texto tachado, links automáticos, emojis (através de pacotes adicionais) e muito mais, indo além do CommonMark básico. Você pode configurar facilmente o pipeline de processamento, ativando apenas as extensões necessárias, o que permite controlar tanto a funcionalidade quanto o desempenho.

O Markdig também é conhecido por sua confiabilidade. Ele é usado ativamente em projetos de grande porte, como o gerador de sites estáticos Statiq, a plataforma de documentação DocFX e muitos outros. Graças à sua arquitetura modular, você pode não apenas usar as extensões integradas, mas também criar as suas próprias, abrindo possibilidades quase ilimitadas de personalização. Neste artigo, vamos detalhar a instalação, os principais métodos, apresentar exemplos práticos e dar dicas para usar o Markdig de forma eficiente.

Instalação

A instalação do Markdig em um projeto .NET é feita através do gerenciador de pacotes NuGet. Você pode usar o console do gerenciador de pacotes, a interface do Visual Studio ou o .NET CLI. Abaixo estão as três formas.

Via .NET CLI (recomendado):

dotnet add package Markdig

Via Console do Gerenciador de Pacotes (Package Manager Console):

Install-Package Markdig

Via interface do Visual Studio:
Abra "Gerenciar Pacotes NuGet" (clique direito no projeto -> Gerenciar Pacotes NuGet), procure por "Markdig" e clique em "Instalar".

Após a instalação, uma referência ao assembly Markdig.dll será adicionada ao seu projeto, e você poderá começar a usar a biblioteca.

Início Rápido

Vamos começar com o exemplo mais simples: converter uma string Markdown em HTML.

using Markdig;

string markdownContent = "# Olá, mundo!\n\nEste é um texto **negrito** e *itálico*.";
string htmlContent = Markdown.ToHtml(markdownContent);

Console.WriteLine(htmlContent);
// Saída:
// <h1>Olá, mundo!</h1>
// <p>Este é um texto <strong>negrito</strong> e <em>itálico</em>.</p>

Como você pode ver, é muito simples. O método estático Markdown.ToHtml() faz todo o trabalho para você. No entanto, isso é apenas a ponta do iceberg. A seguir, veremos recursos mais avançados.

Principais Métodos e Classes

Para um ajuste mais fino no processamento do Markdown, o Markdig oferece um conjunto de classes e métodos. Vamos explorar 8 deles.

1. Markdown.ToHtml(string markdown)

Assinatura: public static string ToHtml(string markdown)

O que faz: Converte uma string Markdown em uma string HTML, usando o pipeline padrão com as extensões CommonMark.

string html = Markdown.ToHtml("**Olá** *Mundo*");
Console.WriteLine(html); // <p><strong>Olá</strong> <em>Mundo</em>.</p>