Sublinhado no Markdown: o que funciona no GitHub e em outros renderizadores

Markdown não tem sintaxe nativa para sublinhar texto. No CommonMark e no GitHub Flavored Markdown, _texto_ significa itálico e __texto__ significa negrito. O sublinhado geralmente requer suporte a HTML ou uma extensão específica do aplicativo.

No GitHub, a forma documentada é:

O <ins>prazo revisado</ins> termina na sexta-feira.

O GitHub lista <ins>...</ins> para texto sublinhado em sua documentação de formatação básica. É uma opção HTML aceita pela plataforma, não um novo delimitador Markdown que funciona em todo lugar.

Comparação entre sublinhado, negrito e itálico

Código	Significado	Onde esperar esse comportamento
_importante_	Ênfase, geralmente itálico	CommonMark e GFM
__importante__	Ênfase forte, geralmente negrito	CommonMark e GFM
**importante**	Ênfase forte, geralmente negrito	CommonMark e GFM
<ins>texto adicionado</ins>	Texto inserido, geralmente sublinhado	Renderizadores com HTML habilitado; documentado pelo GitHub
<u>texto anotado</u>	Anotação HTML, geralmente sublinhada	Renderizadores que permitem esse elemento HTML

Escolha negrito ou itálico quando o objetivo for dar ênfase. Por exemplo, **Entrega na sexta-feira** continua útil em um README, uma nota e uma exportação Markdown sem depender de HTML bruto.

Qual é a diferença entre ins e u?

As duas tags podem parecer semelhantes, mas têm significados diferentes.

<ins> representa texto inserido em um documento. É adequado para uma revisão, como um requisito recém-adicionado. O navegador costuma sublinhá-lo, mas uma folha de estilos pode mudar sua aparência. Veja a referência de texto inserido da MDN.

A versão oferece suporte a <ins>importações CSV e TSV</ins>.

<u> marca uma anotação que não é uma ênfase comum, como sinalizar um erro ortográfico. O HTML moderno não o define como uma tag genérica para “tornar isto importante”. Veja a referência do elemento u da MDN.

Confira a grafia de <u>excessão</u>.

Se você controla um site e precisa de um sublinhado puramente visual, aplique text-decoration: underline por CSS. Uma plataforma Markdown hospedada pode remover atributos de estilo ou impedir estilos personalizados, portanto essa abordagem também não é portátil.

Por que o sublinhado funciona em um editor e desaparece em outro?

São três decisões separadas: o analisador Markdown reconhece HTML, o aplicativo escolhe quais tags permite e a folha de estilos do destino determina a aparência dos elementos permitidos. Oferecer suporte a GFM não garante que um produto permita todas as tags HTML.

O editor MD File Viewer atualmente remove tags HTML brutas da entrada do usuário. Ao colar <ins>texto adicionado</ins> ou <u>texto anotado</u>, as palavras permanecem sem essas tags, então a prévia não as sublinha. Use essa prévia para a formatação Markdown compatível e verifique a formatação baseada em HTML no destino em que ela será publicada.

Se você está transferindo um documento HTML para Markdown, o conversor HTML para Markdown ajuda a recuperar texto, títulos, links e listas. Sublinhado e CSS personalizado podem se perder porque Markdown simples não tem sintaxe equivalente. Confira o resultado antes de substituir o documento original.

Exemplos para README do GitHub

Para uma breve adição em uma nota de alteração, a opção HTML documentada pelo GitHub é:

Esta versão adiciona <ins>uma etapa de importação opcional</ins>.

Para um prazo ou requisito, use ênfase Markdown:

**Obrigatório:** Inclua uma linha de cabeçalho no arquivo CSV.

Para um destino, use um link:

[Leia as instruções de importação](https://example.com/import)

Texto sublinhado pode parecer um link clicável. Evite fazer rótulos comuns parecerem interativos, especialmente quando o mesmo parágrafo contém links reais. O guia de links Markdown aborda textos de link descritivos e links de referência.

Erros comuns com sublinhado

Sublinhados duplos deixam o texto em negrito. Trocar **palavra** por __palavra__ muda o delimitador, não o significado. Ambos representam ênfase forte.

Crases exibem a tag como código. Escrever `<ins>texto</ins>` é útil em um tutorial, mas mostra intencionalmente a marcação em vez de renderizá-la.

Atalhos de teclado pertencem ao aplicativo. Um editor de texto rico pode oferecer um comando de sublinhado e salvar HTML ou seu próprio formato de documento. Isso não torna o sublinhado parte do Markdown portátil.

Um título sublinhado é um conceito diferente. Neste código, os hífens criam um título de nível dois:

Notas da versão
-------------

Eles não sublinham uma expressão dentro de um parágrafo. Para separar seções, use uma linha horizontal Markdown com linhas em branco ao redor.

Perguntas frequentes

Como sublinho em Markdown no GitHub?

Use <ins>texto</ins>, que o GitHub documenta para sublinhado. Para dar ênfase em renderizadores sem suporte a HTML, use **texto** ou *texto*.

Existe uma alternativa de sublinhado apenas com Markdown?

Não existe um delimitador padrão de sublinhado. Alguns aplicativos adicionam sua própria sintaxe, mas você precisa verificar a documentação e o formato usado na exportação.

O sublinhado será preservado ao converter Markdown para PDF ou Word?

Somente se o conversor preservar o HTML ou a extensão relevante e aceitar seus estilos. Não presuma que um sublinhado visível na prévia de um aplicativo será preservado por outro exportador. Inspecione o arquivo resultante ou use negrito padrão quando a portabilidade for importante.

A folha de referência Markdown oferece uma referência compacta das formatações que possuem sintaxe Markdown própria.