Formateur Markdown
Nettoyez Markdown avec ce formateur Markdown. Collez un README, une page de documentation ou des notes : l'outil supprime les lignes vides au début et à la fin, puis réaligne tous les tableaux à barres verticales. Les cellules sont complétées jusqu'à la largeur de l'entrée la plus longue de leur colonne, et la ligne de séparation est recréée avec des tirets correspondants, tout en conservant les deux-points d'alignement. Le reste est conservé tel quel : rédacteurs et développeurs obtiennent des tableaux propres sans mauvaise surprise.
Foire aux questions
Que modifie le formateur Markdown ?
Il réaligne les tableaux à barres verticales et supprime les lignes vides ainsi que les espaces au début et à la fin du document. Les titres, paragraphes, listes, liens et emphases restent exactement tels que vous les avez écrits.
Comment les tableaux sont-ils formatés ?
Chaque ligne reçoit une barre verticale au début et à la fin. Chaque cellule est complétée par des espaces jusqu'à la largeur de la cellule la plus large de sa colonne, et les colonnes font au moins trois caractères de large. La ligne de séparation est recréée avec des tirets de même largeur.
Les alignements des colonnes sont-ils conservés ?
Oui, les deux-points de la ligne de séparation sont conservés. Les alignements à gauche, au centre et à droite, écrits sous les formes :---, :---: et ---:, sont maintenus après le reformatage.
Les tableaux dans les blocs de code sont-ils modifiés ?
Non, tout ce qui se trouve entre des clôtures de trois accents graves ou de trois tildes reste intact. Cela inclut le texte qui ressemble à un tableau à l'intérieur des blocs de code.
Pourquoi les colonnes contenant des lettres accentuées ou des emoji semblent-elles mal alignées ?
La largeur des cellules est mesurée en octets UTF-8, donc les caractères hors ASCII comptent pour deux à quatre octets. Les colonnes qui en contiennent peuvent recevoir un espacement supplémentaire dans un éditeur de texte brut, mais le tableau affiché n'est pas affecté.
Modifie-t-il les marqueurs de liste ou le style des titres ?
Non, les marqueurs de liste, la numérotation, les marqueurs de titre et les espaces à l'intérieur des paragraphes sont conservés tels quels. Le formateur est volontairement prudent afin de ne jamais modifier le rendu de votre document.
Le document formaté s'affiche-t-il différemment ?
Non, compléter les cellules du tableau et supprimer les lignes vides au début et à la fin du document ne modifie pas le rendu. GitHub, GitLab et les autres moteurs de rendu affichent les mêmes tableaux avant et après.
Puis-je l'utiliser pour des fichiers MDX ?
Oui, mais le formateur MDX convient mieux, car il marque le résultat comme mdx. Les deux appliquent les mêmes règles et laissent les imports et JSX intacts.
Pourquoi le résultat est-il encadré par une clôture de code markdown ?
La sortie est renvoyée dans un bloc de code marqué markdown ; elle apparaît donc comme du code source lorsqu'elle est collée dans une visionneuse Markdown. Pour votre fichier .md, copiez les lignes entre les clôtures extérieures.
Quelle peut être la taille de mon document ?
Jusqu'à 5 MB par exécution ; toute entrée plus volumineuse est rejetée avec un message. La sortie est identique à l'option Markdown du formateur de code.