DevToy

Tabelas Markdown

Criar tabelas melhores para arquivos README do GitHub

Um fluxo fácil de revisar para tabelas README concisas, incluindo títulos, alinhamento, links, badges e leitura no celular.

Publicado 11 de julho de 2026 · Atualizado 11 de julho de 2026

Uma tabela README deve responder rapidamente a uma pergunta: qual pacote instalar, qual recurso é suportado ou qual ambiente passou? Ela atrapalha quando vira layout geral da página ou contém parágrafos que não cabem em uma tela pequena.

Dê uma função a cada coluna

Use títulos curtos e concretos:

| Pacote | Runtime | Status |
| :--- | :---: | :---: |
| `core` | Node 22 | Estável |
| `cli` | Node 22 | Beta |

Nomes ficam à esquerda, campos curtos podem ser centralizados e números geralmente ficam à direita. Descrições com várias frases devem ficar fora da tabela.

Evite URLs longas nas células. [Referência da API](./docs/api.md) mantém a coluna compacta e explica o destino para leitores de tela. Badges são imagens e geram ruído visual; reserve-os para poucos sinais atualizados continuamente e forneça texto alternativo útil.

Otimize para revisão do código

Quem revisa um pull request lê o resultado e o diff. Mantenha um registro por linha e evite centenas de espaços para alinhamento manual. Para matrizes geradas, versione também o script ou a fonte para permitir rastreamento.

Confira telas estreitas

Ao rolar uma tabela larga horizontalmente, o contexto da linha se perde. Coloque a identificação mais importante primeiro, limite colunas e separe dimensões não relacionadas. Uma linha muito mais longa que as outras provavelmente merece uma seção própria.

Mantenha afirmações atuais

Matrizes de recursos envelhecem rápido. Atualize o README no mesmo pull request que muda a compatibilidade.

Crie e alinhe a fonte no gerador de tabelas Markdown e valide a renderização no GitHub antes de integrar.

Guias relacionadas