Folha de Dicas do Markdown

Etapa 1 / 3 33%

Escolha um tema de Markdown

Comece com um grupo de exemplos e depois abra a referência completa.

A sintaxe essencial de Markdown, organizada por categoria e mostrada com o código pronto para copiar e a saída de um analisador real. Abrange os fundamentos do CommonMark (títulos, listas, ênfase, links, imagens e blocos de código cercados) e as extensões do GitHub Flavored Markdown (tabelas, listas de tarefas, texto riscado e links automáticos para URLs sem formatação). Mantenha esta página à mão ao alternar entre GitHub, GitLab, Obsidian e geradores de sites estáticos.

Como usar a folha de dicas

  1. 1

    Navegue por categoria

    Vá para cabeçalhos, listas, código, links, tabelas ou extensões GFM.

  2. 2

    Compare fonte e resultado

    Cada exemplo mostra o Markdown bruto ao lado da saída de um analisador GFM real.

  3. 3

    Copie o trecho

    Toque em copiar para pegar o código-fonte de qualquer exemplo.

  4. 4

    Confira a etiqueta da sintaxe

    Cada exemplo é identificado como CommonMark ou GitHub Flavored Markdown (GFM).

Cabeçalhos

# Título H1
## Seção H2
### Subseção H3

Use o estilo ATX (#) em vez do Setext (=== abaixo do texto). Todos os analisadores suportam ambos, mas o ATX é mais fácil de ler em um diff.

Ênfase

*itálico* ou _itálico_, **negrito** ou __negrito__, ***negrito itálico***. O GFM adiciona ~~riscado~~.

Listas

Listas não ordenadas usam -, * ou + (escolha um e mantenha-se com ele):

- Primeiro
- Segundo
  - Aninhado (dois espaços)

Listas ordenadas renumeram automaticamente:

1. Item
1. Item
1. Item

Código

Inline: `código`. Blocos cercados com tag de linguagem opcional:

```python
def hello(name):
    return f"Olá, {name}"
```

Indente com quatro espaços para um bloco de código se você preferir a sintaxe mais antiga.

Links e imagens

[Texto do link](https://example.com)
[Link com título](https://example.com "Tooltip")
![Texto alternativo](/path/to/image.png)

O estilo de referência mantém URLs longas fora do parágrafo:

Veja a [documentação][1].

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

Tabelas (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

O alinhamento usa dois pontos na linha separadora: :--- esquerda, :---: centro, ---: direita.

Listas de tarefas (GFM)

- [x] Feito
- [ ] A fazer

Armadilhas comuns

  • Dois espaços finais inserem uma quebra de linha dentro de um parágrafo. Um espaço apenas junta as linhas.
  • Linha em branco necessária antes da maioria dos elementos de bloco (cabeçalhos, listas, blocos de código).
  • Não indente marcadores de lista com tabs se seu renderizador espera espaços; indente com dois ou quatro espaços.
  • Escape com barra invertida para pontuação literal: \*não itálico\*.
  • Aspas inteligentes diferem por renderizador. O GitHub as deixa como estão; o Pandoc converte.

Perguntas frequentes

CommonMark define o núcleo portátil, incluindo títulos, listas, links e blocos de código cercados com uma informação opcional. GFM acrescenta tabelas, listas de tarefas, texto riscado e links automáticos para URLs sem formatação. Outros editores podem implementar apenas uma parte ou adicionar extensões próprias.

O Markdown trata uma única nova linha como um espaço. Para um <br>, termine a linha com dois espaços finais ou use \ no final da linha em GFM.

Sim, na maioria dos analisadores, tags HTML de nível de bloco são passadas. Alguns renderizadores sanitizam isso (o GitHub remove scripts inline e atributos de evento).

CommonMark não inclui sintaxe para sumário. O GitHub cria âncoras de títulos e mostra uma estrutura em arquivos com vários títulos. Outras plataformas têm regras próprias: o MkDocs pode usar [TOC] com a extensão correspondente, enquanto o Docusaurus gera o sumário da página a partir dos títulos.

As regras do CommonMark e GFM funcionam. O Obsidian adiciona wikilinks ([[Nome da página]]), chamadas e blocos incorporados que são exclusivos do Obsidian, esses não estão nesta folha de dicas.

Ferramentas relacionadas