Skip to main content

Markdown

Apresentação​

O Markdown é um componente que permite renderizar conteúdo em formato Markdown de forma segura e sem dependências externas. Ele converte texto Markdown em HTML e aplica sanitização para garantir a segurança do conteúdo renderizado.

Quando usar​

  • Quando precisar exibir conteúdo formatado em Markdown
  • Para renderizar documentação ou textos formatados
  • Quando precisar converter texto simples em HTML de forma segura
  • Para exibir conteúdo que requer formatação básica (títulos, listas, ênfase)

Forma básica de uso​


// Exemplo básico
<Markdown content="# Título\n\nEste é um **texto em negrito**" />

// Com classes personalizadas
<Markdown 
  content="## Subtítulo\n\n- Item 1\n- Item 2" 
  className="p-4"
/>

Propriedades​

PropriedadeTipoDescrição
contentstringO conteúdo em formato Markdown que será convertido e renderizado como HTML

Tags HTML Permitidas​

O componente sanitiza o HTML gerado e permite apenas as seguintes tags:

  • p (parágrafos)
  • h1, h2, h3 (títulos)
  • strong (negrito)
  • em (itálico)
  • ul, ol, li (listas)
  • br (quebra de linha)

Heranças​

O componente Markdown herda todas as propriedades comuns da biblioteca através da interface CommonProps, que inclui:

  • Propriedades de estilo (margin, padding, etc)
  • Propriedades de layout (flex, grid, etc)
  • Propriedades de posicionamento
  • Propriedades de acessibilidade
  • Propriedades de identificação (id, data-e)

Observações​

  • O componente utiliza DOMPurify para sanitização do HTML gerado
  • Apenas tags HTML específicas são permitidas por questões de segurança
  • O componente não suporta imagens ou links por questões de segurança