Um ótimo `README.md` é a diferença entre um projeto de código aberto bem-sucedido e um projeto abandonado. E uma das melhores maneiras de apresentar documentação de API, comparações de recursos ou opções de configuração é usando tabelas.
Infelizmente, o Markdown padrão não facilita as tabelas.
A luta da tabela Markdown
Escrever uma tabela Markdown manualmente fica assim:
```redução | Propriedade | Tipo | Descrição | |---|---|---| | identificação | corda | O identificador exclusivo | | tempo limite | número | Tempo em milissegundos | ```
Se você adicionar uma descrição longa a uma linha, toda a tabela ficará visualmente desalinhada em seu editor de código, tornando-a incrivelmente difícil de manter e ler.
Geração Visual
O fluxo de trabalho mais eficiente é usar uma grade visual. Com nosso [Markdown Table Generator](/en/markdown-table-generator), você pode digitar seu conteúdo em uma interface semelhante a uma planilha.
Você pode adicionar colunas, excluir linhas e digitar naturalmente. Quando terminar, a ferramenta gera instantaneamente a sintaxe Markdown perfeitamente espaçada e formatada de forma limpa. Basta copiá-lo e colá-lo em seu README.
Pare de brigar com barras verticais (`|`) e travessões e comece a gerar suas tabelas visualmente!