Sintaxe Markdown com exemplos práticos

Encontre a sintaxe, copie um exemplo e compare código e resultado. As seções diferenciam a base portátil do CommonMark de extensões comuns do GFM; o destino ainda precisa ser conferido.

Testar no editor

Markdown em poucas palavras

Markdown usa sinais simples para descrever estrutura: # para títulos, asteriscos para ênfase, hífens para listas e colchetes com parênteses para links. Tabelas, listas de tarefas e tachado são extensões comuns do GFM e podem variar entre plataformas.

01

Como usar Referência rápida do Markdown

Trabalhe primeiro com uma dúvida de sintaxe ou um exemplo; só considere a tarefa concluída depois de conferir exemplos Markdown copiáveis.

  1. 1Adicionar a origemDigite, cole ou abra uma dúvida de sintaxe ou um exemplo. O conteúdo continua disponível para correção durante a tarefa.
  2. 2Revisar a estruturaRevise a estrutura principal, confira os elementos que devem permanecer e corrija o que não fizer sentido antes de gerar o resultado.
  3. 3Consultar a sintaxeUse a ação “Consultar a sintaxe” e verifique exemplos Markdown copiáveis no programa ou no destino em que será usado.
Títulos

Criar títulos com #

Use de um a seis sinais #, seguidos de espaço. Mantenha um único H1 por documento quando a plataforma tratar H1 como título principal.

# Título principal
## Seção
### Subseção

Resultado: Três níveis de título

  • Inclua espaço depois de #
  • Não pule níveis sem necessidade
Texto

Separar parágrafos

Deixe uma linha em branco entre blocos de texto.

Primeiro parágrafo.

Segundo parágrafo.

Resultado: Dois parágrafos

  • Uma quebra simples pode virar espaço
  • Use linha em branco para prosa
Ênfase

Negrito, itálico e tachado

Asteriscos ou sublinhados marcam ênfase. O tachado com ~~ é uma extensão comum do GFM.

**negrito**
*itálico*
~~tachado~~

Resultado: Texto com três tipos de ênfase

  • Não deixe espaço dentro dos marcadores
  • Confirme extensões no destino
Listas

Lista com marcadores

Use hífen, asterisco ou sinal de mais seguido de espaço.

- Primeiro
- Segundo
  - Aninhado

Resultado: Lista com subitem

  • Mantenha o marcador consistente
  • Recuo controla o aninhamento
Listas

Lista numerada

Use número, ponto e espaço. Muitos renderizadores recalculam a numeração.

1. Preparar
2. Revisar
3. Publicar

Resultado: Lista ordenada com três itens

  • Não omita o espaço
  • Teste listas aninhadas
Imagens

Inserir imagem e texto alternativo

Adicione ! antes da sintaxe de link. O texto entre colchetes descreve a imagem.

![Diagrama do fluxo](https://example.com/fluxo.png)

Resultado: Imagem com texto alternativo

  • Prefira descrição útil
  • Confira permissões e disponibilidade da URL
Citações

Criar citação em bloco

Comece cada linha do bloco com >. Acrescente outro > para aninhar.

> Uma observação importante.
>
> Segundo parágrafo.

Resultado: Citação com dois parágrafos

  • Use > também na linha vazia
  • Não confunda citação com crédito
Código

Código em linha

Use crases para nomes de comando, arquivo ou trecho curto.

Execute `npm run build`.

Resultado: Comando em fonte de código

  • Não use para ênfase comum
  • Para crase literal, use delimitador maior
Código

Bloco de código cercado

Use três crases antes e depois. Um identificador de linguagem pode ativar realce.

```js
const ok = true;
```

Resultado: Bloco de código JavaScript

  • Feche o bloco
  • Não altere o conteúdo literal
Tabelas

Criar tabela Markdown

A primeira linha traz os cabeçalhos, a segunda usa hífens e as demais trazem os dados. A tabela é uma extensão comum do GFM.

| Ferramenta | Uso |
| --- | --- |
| Editor | Escrever |
| Conversor | Exportar |

Resultado: Tabela de duas colunas

  • Mantenha a mesma quantidade de células
  • Escape uma barra vertical literal como \|
Criar uma tabela Markdown
GFM

Lista de tarefas

Use [ ] para pendente e [x] para concluído depois do marcador.

- [x] Escrever
- [ ] Revisar

Resultado: Uma tarefa concluída e outra pendente

  • Inclua espaço depois do colchete
  • Interatividade depende da plataforma
Separadores

Linha horizontal

Use três ou mais hífens, asteriscos ou sublinhados em uma linha isolada.

Texto acima

---

Texto abaixo

Resultado: Texto separado por uma linha

  • Deixe linhas em branco ao redor
  • Evite confundir com título Setext
Quebras

Quebra de linha explícita

Dois espaços no fim criam uma quebra em CommonMark; uma barra invertida também pode funcionar em destinos compatíveis.

Primeira linha  
segunda linha

Resultado: Duas linhas no mesmo parágrafo

  • Mostre espaços invisíveis no editor
  • Teste no destino final
Caracteres

Escapar símbolos

Use barra invertida antes de um símbolo que não deve ser interpretado como sintaxe.

\*isto não é itálico\*

Resultado: Asteriscos visíveis

  • Escape só quando necessário
  • Regras variam dentro de código
Extensões

Notas de rodapé

Alguns renderizadores aceitam referência [^1] e definição correspondente; CommonMark básico não exige esse recurso.

Texto com nota.[^1]

[^1]: Detalhe da nota.

Resultado: Referência e nota de rodapé

  • Confirme suporte no destino
  • Use identificadores únicos
Avançado

HTML dentro do Markdown

Algumas plataformas aceitam HTML embutido; outras removem ou escapam as tags.

<details><summary>Detalhes</summary>Texto</details>

Resultado: Bloco expansível somente onde houver suporte

  • Evite depender de HTML para portabilidade
  • Nunca inclua código não confiável
Compatibilidade

CommonMark e GitHub Flavored Markdown

A sintaxe básica é amplamente aceita, mas extensões não são universais. Confira o editor, CMS ou repositório em que o conteúdo será publicado.

Base / CommonMark

Títulos, parágrafos, ênfase, citações, listas, código, links, imagens e linhas horizontais formam a base portátil.

Extensões GFM

Tabelas, tarefas, tachado e autolinks ampliados dependem do renderizador.

Consulte as especificações: CommonMark · GFM

Perguntas sobre a sintaxe Markdown

O que é mantido em exemplos Markdown copiáveis?

Cada módulo mostra código e resultado esperado. Tabelas, tarefas e tachado são marcados como extensões. Notas de compatibilidade evitam prometer um único dialeto. Ainda assim, confira o resultado no destino final.

Por que exemplos Markdown copiáveis pode ficar diferente da origem?

Os formatos não têm os mesmos recursos. A referência não cobre todas as extensões de cada plataforma. Tabelas e tarefas não pertencem ao núcleo CommonMark.

Como revisar exemplos Markdown copiáveis antes de usar?

Teste HTML incorporado e regras específicas no destino. Guarde a origem até terminar essa comparação.