PureTools

Sintaxe Markdown: Cheatsheet Completo

PureTools Team· 7 min de leitura
Sintaxe Markdown: Cheatsheet Completo

Markdown: Escreva Uma Vez, Renderize em Todo Lugar

Markdown é a língua franca da documentação de desenvolvedores. Arquivos README, descrições de pull request, páginas do Notion, mensagens do Slack e geradores de sites estáticos todos usam. Aprenda a sintaxe uma vez e pode escrever conteúdo formatado em qualquer lugar.

Formatação Básica de Texto

**texto em negrito**
*texto em itálico*
***negrito e itálico***
~~tachado~~
`código inline`

> Citação — ótimo para destacar notas importantes
>
> Citações multi-linha também funcionam

Renderiza como: texto em negrito, texto em itálico, negrito e itálico, tachado, código inline.

Headings

# Heading 1    (título da página — use uma vez)
## Heading 2   (seções principais)
### Heading 3  (subseções)
#### Heading 4 (raramente necessário)

Sintaxe alternativa:
Heading 1
=========

Heading 2
---------

Links e Imagens

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

![Texto alt](imagem.png)
![Texto alt](imagem.png "Título opcional")


[Google][1]
[GitHub][gh]

[1]: https://google.com
[gh]: https://github.com

Listas

Não ordenada:
- Item um
- Item dois
  - Item aninhado (2 espaços de indentação)
  - Outro aninhado
- Item três

Ordenada:
1. Primeiro
2. Segundo
3. Terceiro
   1. Ordenada aninhada

Lista de tarefas (GitHub):
- [x] Tarefa concluída
- [ ] Tarefa pendente
- [ ] Outra pendente

Blocos de Código

Inline: Use `const x = 1` no seu código.

Bloco cercado com syntax highlighting:
```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"
```

```bash
curl -X POST https://api.example.com/data \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'
```

Tabelas

| Feature       | Markdown | HTML    |
|---------------|----------|---------|
| Aprendizado   | Fácil    | Médio   |
| Legibilidade  | Alta     | Baixa   |
| Flexibilidade | Média    | Alta    |

Alinhamento:
| Esquerda | Centro | Direita |
|:---------|:------:|--------:|
| E        |   C    |       D |

Linhas Horizontais

Três ou mais hifens, asteriscos ou underscores:

---
***
___

GitHub-Flavored Markdown (GFM)

O GitHub adiciona várias extensões:

URLs autolinked: https://github.com

Mencionar usuários: @username
Referenciar issues: #123
Referenciar commits: abc1234

Emoji: :rocket: :tada: :bug:

Notas de rodapé:
Isso tem uma nota[^1].

[^1]: Este é o conteúdo da nota de rodapé.

Alertas (desde 2023):
> [!NOTE]
> Informação útil.

> [!WARNING]
> Conteúdo crítico.

> [!TIP]
> Conselho útil.

Escapando Caracteres Especiais

\*não itálico\*
\# não é heading
\[não é link\]
\`não é código\`

Boas Práticas para READMEs

  • Comece com um título claro e descrição de uma linha do que o projeto faz
  • Adicione badges (status do build, versão npm, licença) logo após o título
  • Inclua uma seção Quick Start com comandos de install + run copiáveis
  • Use headings para criar estrutura escaneável: Instalação, Uso, API, Contribuindo
  • Adicione exemplos de código com a linguagem especificada para syntax highlighting

Converta seu Markdown: Markdown para HTML — cole Markdown, obtenha HTML limpo instantaneamente.

← Voltar ao blog