Guia rápido de Markdown: sintaxe do GitHub-Flavored Markdown com exemplos

Markdown é a forma mais simples de escrever texto formatado que continua legível como texto puro. Arquivos README, documentação, anotações, mensagens de chat e sites estáticos usam Markdown. Este guia rápido cobre a sintaxe que você vai realmente usar, com foco no GitHub-Flavored Markdown (GFM) — o dialeto suportado pelo GitHub, pelo GitLab, pela maioria das ferramentas de documentação e pelo Markdown Preview Editor.

Todos os exemplos abaixo podem ser colados no editor online para ver o resultado lado a lado.

Títulos

Comece a linha com um a seis caracteres # seguidos de um espaço. Um # é o título da página, ## uma seção, ### uma subseção.

markdown# Título da página
## Seção
### Subseção
#### Título menor

Use um único título # por documento e não pule níveis (por exemplo, de ## direto para ####). Leitores de tela e mecanismos de busca usam a estrutura de títulos para entender a página, e a maioria dos visualizadores monta um sumário a partir dela.

Parágrafos e quebras de linha

Um parágrafo é uma ou mais linhas de texto separadas por uma linha em branco. Uma quebra de linha simples dentro de um parágrafo é ignorada — as linhas são unidas. Para forçar uma quebra de linha, termine a linha com dois espaços ou uma barra invertida:

markdownPrimeira linha com dois espaços no final  
Segunda linha no mesmo parágrafo.

Um novo parágrafo começa depois de uma linha em branco.

Ênfase

Muitos editores, incluindo o Markdown Preview Editor, também suportam algumas extensões populares: ==destaque==, H~2~O para subscrito, x^2^ para sobrescrito e códigos de emoji no estilo :smile:. Elas não fazem parte do GFM, então confira a plataforma de destino antes de depender delas.

Listas

Use -, * ou + para listas com marcadores e números para listas numeradas. Recue de dois a quatro espaços para aninhar itens.

markdown- Leite
- Pão
  - Integral
  - De centeio
- Café

1. Clonar o repositório
2. Instalar as dependências
3. Rodar o build

Listas numeradas não precisam dos números corretos — 1. em todas as linhas ainda aparece como 1, 2, 3. Começar com outro número (por exemplo 5.) faz a lista começar a partir dele.

Listas de tarefas

Listas de tarefas são uma extensão do GFM que transforma itens de lista em caixas de seleção. São perfeitas para READMEs, planos de lançamento e atas de reunião.

markdown- [x] Escrever o rascunho
- [x] Adicionar capturas de tela
- [ ] Publicar o post

Links

markdown[Texto do link](https://example.com)
[Link com título](https://example.com "Aparece ao passar o mouse")
<https://example.com>

Leia o [guia de instalação][install].

[install]: https://example.com/docs/install

A última forma é um link de referência: o URL é definido uma única vez no final do documento, o que mantém parágrafos longos legíveis. Links relativos como [Configuração](docs/setup.md) apontam para outros arquivos do mesmo projeto; no Markdown Preview Editor, eles mudam para esse documento se ele estiver aberto em outra aba.

Imagens

Imagens usam a sintaxe de link com um ponto de exclamação na frente. O texto entre colchetes é o texto alternativo — descreva a imagem para quem não pode vê-la.

markdown![Editor com visualização ao vivo](images/screenshot.png)
![Logotipo](https://example.com/logo.svg "Título opcional")

Ao visualizar um documento que faz referência a imagens locais, abra a pasta inteira ou solte as imagens junto com o arquivo .md, para que o visualizador consiga resolver os caminhos relativos.

Código

Código embutido usa crases simples. Para blocos, envolva o código em três crases e adicione o nome da linguagem para ter realce de sintaxe:

markdown```js
function greet(name) {
  return `Hello, ${name}!`;
}
```

Nomes de linguagem comuns: js, ts, python, bash, json, yaml, html, css, sql, go, rust, diff. Se o próprio código contiver três crases, delimite-o com quatro crases, como no exemplo acima.

Tabelas

Separe as colunas com barras verticais e coloque uma linha de hifens abaixo do cabeçalho. Dois-pontos na linha separadora definem o alinhamento.

markdown| Recurso      | Grátis | Observações            |
|:-------------|:------:|-----------------------:|
| Visualização |   ✅   | Atualiza ao digitar    |
| Exportação   |   ✅   | HTML, PDF, .md         |

:--- alinha à esquerda, :---: centraliza e ---: alinha à direita. As colunas não precisam estar alinhadas no código-fonte — mas um bom editor as mantém legíveis. O Markdown Preview Editor tem um botão de tabela na barra de ferramentas que insere um modelo pronto.

Citações e avisos

Comece as linhas com > para citar um texto. O GitHub também suporta avisos (alerts) — citações com uma primeira linha especial que aparecem como caixas coloridas de destaque:

markdown> Uma citação comum.

> [!NOTE]
> Informação útil que os usuários devem saber.

> [!TIP]
> Um conselho para fazer as coisas melhor.

> [!WARNING]
> Informação urgente que exige atenção imediata.

Os cinco tipos de aviso são NOTE, TIP, IMPORTANT, WARNING e CAUTION. Use com moderação: um aviso por seção se destaca, cinco seguidos viram ruído.

Notas de rodapé

Notas de rodapé tiram os comentários paralelos do texto principal. A nota pode ser definida em qualquer lugar; ela aparece no final do documento.

markdownO Markdown foi criado em 2004.[^1]

[^1]: Por John Gruber, com a ajuda de Aaron Swartz.

Linhas horizontais e escape de caracteres

Três ou mais hifens, asteriscos ou sublinhados sozinhos em uma linha criam uma linha horizontal: ---. Deixe uma linha em branco antes dela; caso contrário, --- abaixo de uma linha de texto transforma esse texto em título.

Para exibir um caractere que o Markdown interpretaria, escape-o com uma barra invertida: \*não é itálico\*, \# não é título, \$5 (útil quando as fórmulas estão ativadas).

Fórmulas e diagramas

Duas extensões viraram padrão na escrita técnica:

• Fórmulas — $E = mc^2$ para fórmulas na linha e $$ … $$ para equações em destaque. Veja o guia completo sobre como escrever fórmulas matemáticas em Markdown.
• Diagramas — um bloco de código com a linguagem mermaid desenha fluxogramas, diagramas de sequência, gráficos de Gantt e mais. Veja diagramas Mermaid em Markdown.

Front matter

Geradores de sites estáticos leem metadados de um bloco YAML no topo do arquivo:

yaml---
title: Meu post
date: 2026-09-27
tags: [markdown, docs]
---

Um bom visualizador oculta esse bloco em vez de exibi-lo como texto. O Markdown Preview Editor faz exatamente isso.

Próximos passos

Conhecer a sintaxe é metade do trabalho — a outra metade é ver o resultado enquanto você escreve. Leia como visualizar Markdown online sem enviar seus arquivos e, quando o documento estiver pronto, aprenda como converter Markdown em HTML ou PDF.