Guia de Referência Markdown
Referência rápida da sintaxe Markdown — títulos, listas, links, blocos de código, tabelas e mais, com pré-visualizações renderizadas em tempo real.
Como Usar
- Navegue pelo sumário à esquerda para saltar para qualquer categoria de sintaxe.
- Cada cartão mostra a sintaxe Markdown bruta à esquerda e o resultado renderizado à direita.
- Clique no botão Copiar para copiar o trecho para a área de transferência.
- Use esses trechos diretamente no GitHub, Notion, VS Code, Obsidian ou qualquer editor Markdown.
Perguntas Frequentes
-
O que é Markdown?
Markdown é uma linguagem de marcação leve criada por John Gruber em 2004. Permite escrever texto formatado usando símbolos de texto simples — por exemplo, cercar texto com ** o deixa em negrito. Os arquivos Markdown são convertidos para HTML por renderizadores usados no GitHub, plataformas de blog, ferramentas de documentação e aplicativos de notas.
-
O Markdown é igual em todas as plataformas?
A sintaxe base é amplamente consistente, mas diferentes plataformas suportam diferentes extensões. O GitHub Flavored Markdown (GFM) adiciona listas de tarefas, tachado e tabelas. O Obsidian suporta wikilinks. Algumas plataformas usam o CommonMark como padrão. Esta referência foca nos recursos mais amplamente suportados.
-
Como faço uma quebra de linha em Markdown?
Termine uma linha com dois espaços e pressione Enter para criar uma quebra de linha suave. Para uma quebra de parágrafo, deixe uma linha em branco entre duas linhas. Em muitos renderizadores, uma única quebra de linha sem espaços finais é tratada como um espaço, não como uma quebra.
-
Posso usar HTML dentro do Markdown?
A maioria dos renderizadores Markdown permite HTML inline. Por exemplo, você pode usar <br> para quebra de linha, <u>texto</u> para sublinhado, ou <details> para seções recolhíveis. No entanto, o suporte varia — alguns renderizadores focados em segurança removem o HTML completamente.
O que é Markdown?
Markdown é uma sintaxe de texto simples que se converte em HTML. Criado por John Gruber em 2004, foi projetado para ser legível como está — o texto bruto deve parecer texto formatado mesmo sem renderização. Hoje é usado em todo lugar: READMEs do GitHub, documentação técnica, plataformas de blog, aplicativos de notas como Obsidian e Notion, e ferramentas de chat como Slack e Discord.
A ideia central é simples: usar caracteres comuns para indicar formatação. Um # antes de uma linha a torna um título. Cercar texto com ** o deixa em negrito. Indentar uma linha com quatro espaços a torna um bloco de código.
Como uma Guia de Referência Markdown Ajuda
Mesmo escritores experientes ocasionalmente esquecem a sintaxe exata para alinhar colunas em uma tabela, criar listas aninhadas ou blocos de código com realce de sintaxe. Esta guia serve como consulta rápida — você vê a sintaxe bruta e o resultado renderizado lado a lado.
Esta guia cobre:
- Títulos — quatro níveis de h1 a h4
- Formatação de texto — negrito, itálico, tachado, código inline, hiperlinks
- Listas — ordenadas, não ordenadas, aninhadas e listas de tarefas
- Links e imagens — links inline, links com título, imagens
- Citações — simples e aninhadas
- Blocos de código — delimitados com opção de idioma para realce de sintaxe
- Tabelas — com opções de alinhamento de colunas
- Regras horizontais — como separadores visuais
Dialetos Markdown
CommonMark é uma especificação padronizada que resolve ambiguidades na especificação original. GitHub, GitLab, Discourse e muitas outras plataformas seguem CommonMark ou algo próximo.
GitHub Flavored Markdown (GFM) adiciona listas de tarefas (- [x]), tachado (~~texto~~), tabelas e autolinks. A maioria das plataformas de código suporta GFM ou um superconjunto dele.
Para escrita técnica cotidiana — READMEs, documentação, posts de blog, notas — CommonMark padrão mais as extensões GFM cobre praticamente tudo que você precisa.
Dicas para Escrever Bom Markdown
Seja consistente com marcadores de lista. Escolha - ou * para listas não ordenadas e mantenha essa escolha. Misturar é válido, mas mais difícil de ler na forma bruta.
Use linhas em branco entre elementos de bloco. Uma linha em branco antes e depois de títulos, blocos de código e citações garante renderização correta em diferentes analisadores.
Prefira blocos de código delimitados aos indentados. Blocos com três crases permitem especificar o idioma para realce de sintaxe e são visualmente mais claros na fonte.
Use texto de link descritivo. [Clique aqui](url) é pior que [Especificação Markdown](url) tanto para legibilidade quanto para acessibilidade.