Un bon `README.md` fait la différence entre un projet open source réussi et un projet abandonné. Et l'un des meilleurs moyens de présenter la documentation de l'API, des comparaisons de fonctionnalités ou des options de configuration consiste à utiliser des tableaux.
Malheureusement, le Markdown standard ne rend pas les tableaux faciles.
La lutte contre les tables de démarques
Écrire un tableau Markdown à la main ressemble à ceci :
``` démarque | Propriété | Tapez | Descriptif | |---|---|---| | identifiant | chaîne | L'identifiant unique | | délai d'attente | numéro | Temps en millisecondes | ```
Si vous ajoutez une longue description à une ligne, le tableau entier devient visuellement mal aligné dans votre éditeur de code, ce qui le rend incroyablement difficile à maintenir et à lire.
Génération visuelle
Le flux de travail le plus efficace consiste à utiliser une grille visuelle. Avec notre [Markdown Table Generator](/en/markdown-table-generator), vous pouvez saisir votre contenu dans une interface de type feuille de calcul.
Vous pouvez ajouter des colonnes, supprimer des lignes et taper naturellement. Une fois que vous avez terminé, l'outil génère instantanément la syntaxe Markdown parfaitement espacée et proprement formatée. Il vous suffit de le copier et de le coller dans votre README.
Arrêtez de vous battre avec des caractères pipe (`|`) et des tirets, et commencez à générer vos tableaux visuellement !