Lição 3
GitHub Flavored Markdown
Trabalhe com tabelas GFM, blocos de código com cercas, listas de tarefas e outras extensões amigáveis ao GitHub.
GitHub Flavored Markdown (GFM) estende o Markdown básico com recursos em que desenvolvedores confiam em README e issues.
Tabelas
| Ferramenta | Propósito |
| --- | --- |
| Formatador JSON | Validar payloads de API |
| Visualizar Markdown | Rascunhar arquivos README |
Tabelas são úteis para listas de recursos, matrizes de compatibilidade e comparações rápidas.
Blocos de código com cercas e tags de linguagem
```json
{
"status": "ok"
}
```
Tags de linguagem ajudam renderizadores a aplicar destaque de sintaxe e ajudam leitores a entender o tipo do trecho imediatamente.
Listas de tarefas
- [x] adicionar endpoint
- [ ] atualizar docs
- [ ] adicionar teste de regressão
Listas de tarefas são comuns em templates de issue e checklists de PR.
Tachado
~~opção obsoleta~~
Útil ao documentar chaves de config removidas ou campos de API depreciados.
O que o GFM não garante em todo lugar
Nem todo renderizador Markdown suporta cada recurso GFM. Antes de publicar:
- confirme se a plataforma-alvo suporta tabelas e listas de tarefas
- evite extensões exóticas se o doc precisa renderizar em vários sistemas
Resumo
GFM é o dialeto por trás da maior parte do conteúdo de README e issues no GitHub. Se você escreve para o GitHub primeiro, tabelas, blocos com cercas e listas de tarefas costumam ser escolhas seguras.
Visualize amostras GFM na ferramenta Visualizar Markdown / Markdown para HTML antes de commitar um README ou template de issue.