Formater du Markdown

Comment ça marche

Un README écrit à plusieurs, ou un fichier de notes tenu depuis des années, finit par se dérégler : certains points commencent par *, d'autres par -, les colonnes des tableaux ne tombent plus droit et les titres collent aux paragraphes. Collez le texte dans la zone de gauche. À droite, chaque élément de liste commence par la puce choisie, les sous-éléments sont décalés de deux espaces, les numéros écrits 1) deviennent 1. et les tableaux sont alignés colonne par colonne. Par exemple, une ligne |Commande|Description| et les lignes en dessous sont complétées par des espaces jusqu'à la cellule la plus large, pour former des colonnes droites ; les marques d'alignement comme :- et -: sont conservées. Une ligne vide sépare titres, paragraphes, listes et blocs de code. L'intérieur des blocs de code (ouverts par ```) n'est jamais modifié et vos retours à la ligne dans les paragraphes restent en place. La ligne de résultat donne le nombre de lignes, d'éléments de liste et de tableaux, ou indique que le texte était déjà propre.

Cet outil est aussi connu sous le nom de formater markdown, markdown formatter, aligner tableau markdown, mise en forme markdown, formater readme, markdown beautifier en ligne.

Qu'est-ce que Markdown ?

Le Markdown met en forme du texte brut avec quelques signes : # donne un titre, * ou - un élément de liste, ** du gras et ` du code. Les fichiers README de GitHub, de nombreuses applications de notes et des sites de documentation l'utilisent. Il est pensé pour rester lisible en texte brut ; c'est pourquoi une source propre, avec des tableaux alignés et une seule sorte de puce, compte quand une équipe travaille sur le même fichier.

Qu'est-ce que Tableau Markdown (GFM) ?

Les tableaux Markdown viennent du GitHub Flavored Markdown (GFM) : les cellules sont séparées par |, la ligne --- sous l'en-tête définit le tableau, et :--, --: et :-: indiquent si une colonne est alignée à gauche, à droite ou au centre. L'affichage final ne dépend pas de la largeur des cellules brutes, mais sans colonnes alignées le tableau est très difficile à lire ou à modifier dans la source.

Quelle différence entre formater du Markdown et le convertir en HTML ?

Formater garde le Markdown en Markdown et ne range que le texte brut : une seule puce, tableaux alignés, lignes vides régulières. Le résultat retourne dans le même README. Convertir en HTML transforme le Markdown en code de page web : un titre # devient une balise <h1>, un élément de liste devient <li>, et le résultat va dans une page web ou un e-mail. Cette page fait la première opération ; pour la seconde, utilisez l'outil Markdown vers HTML.

La mise en forme change-t-elle l'affichage du Markdown ?

Non. GitHub, GitLab ou une application de notes ignorent les espaces en trop et le type de puce quand ils transforment le Markdown en HTML : le texte remis en ordre produit la même page. Ce qui change, c'est la lisibilité du texte brut : le tableau se lit aussi en texte, les modifications de plusieurs personnes ont le même aspect et les différences dans le contrôle de version sont plus petites.

Un point à savoir : selon les règles du Markdown, des lignes qui se suivent avec des puces différentes (* et +) forment deux listes distinctes. L'outil les garde séparées et écrit la deuxième liste avec l'autre puce. Pour une seule liste, écrivez tous ses éléments avec la même puce.

Tiret ou astérisque ?

Les deux sont valides et donnent le même affichage. La documentation de GitHub, Prettier et la plupart des projets open source utilisent le tiret (-) ; l'astérisque (*) est courant dans les anciens documents et certaines applications de notes. Prenez celui qui domine déjà dans votre projet ; l'important est que le fichier soit homogène.

Quand deux listes distinctes se suivent, l'outil écrit la deuxième avec l'autre puce pour que le Markdown ne les fusionne pas. Les listes numérotées utilisent un chiffre et un point (1.) ; la forme 1) est aussi convertie.

• README GitHub, projet open source → - tiret
• Suivre d'anciens documents ou l'habitude de l'équipe → * astérisque
• Étapes numérotées → 1. 2. 3. (l'outil les corrige)

Questions fréquentes

Comment aligner un tableau Markdown ?

Collez le tableau dans la zone de gauche de cette page. Chaque colonne est complétée jusqu'à sa cellule la plus large, la ligne de séparation est élargie de la même façon et les marques d'alignement (:--, --:, :-:) sont conservées. Le contenu des cellules ne change pas.

L'outil modifie-t-il le contenu de mes blocs de code ?

Non. Chaque caractère d'un bloc ouvert par ``` ou ~~~ reste tel quel ; seule une ligne vide est ajoutée avant et après le bloc.

Les lignes de mes paragraphes sont-elles fusionnées ou coupées ?

Non. Les retours à la ligne dans les paragraphes sont conservés ; l'outil ne coupe pas les lignes longues et ne fusionne pas les lignes courtes.

Mon texte est-il envoyé à un serveur ?

Non. La mise en forme se fait entièrement dans votre navigateur ; le texte collé ne quitte pas cette page et n'est enregistré nulle part.