Nettoyer un README
Uniformisez les titres et les listes d’un fichier écrit par plusieurs contributeurs.
Formateur Markdown
Normalisez la présentation d’un texte Markdown afin d’améliorer sa lisibilité et de récupérer une version propre prête à être réutilisée.
- Presse-papiers
Données non envoyées
Résultat
Cet outil vous a-t-il été utile ?
Comment fonctionne cet outil ?
Harmonisez la syntaxe d’un fichier Markdown sans toucher à son contenu : une espace après chaque # de titre, des puces uniformisées en « - », pas plus d’une ligne vide d’affilée et aucune espace inutile en fin de ligne. Le formatage rend la source plus régulière, plus facile à relire et produit des différences plus propres dans un dépôt de code. Le traitement est réalisé dans votre navigateur.
Le formateur parcourt le document ligne par ligne et applique quatre règles. Il ajoute l’espace manquante après les # d’un titre (« #Titre » devient « # Titre ») et réduit les espaces multiples à une seule. Il remplace les puces « * » et « + » par « - », y compris dans les listes indentées. Il ramène toute suite de lignes vides à une seule. Il supprime les espaces et tabulations de fin de ligne.
Certaines constructions sont volontairement protégées. Le contenu des blocs de code délimités par ``` ou ~~~ est conservé à l’identique : un « #include » ou une ligne commençant par « * » dans du code n’est jamais modifié. Les séparateurs horizontaux (---, * * *, ___) restent tels quels, un texte en **gras** placé en début de ligne n’est pas pris pour une puce, et les deux espaces finales qui forcent un saut de ligne en Markdown sont préservées.
Le formateur ne réordonne rien, ne renumérote pas les listes numérotées et ne réécrit ni les tableaux ni les liens. Le texte lui-même n’est jamais reformulé.
Comment utiliser cet outil ?
Coller le Markdown
Saisissez ou importez le document dans le champ « Contenu Markdown ».
Formater
Lancez le formatage : les règles de titres, de puces, de lignes vides et d’espaces sont appliquées.
Relire le résultat
Comparez avec la source, puis copiez ou exportez la version formatée.
Cas d'utilisation
Préparer un commit
Supprimez les espaces de fin de ligne et les lignes vides en trop avant d’enregistrer une documentation.
Normaliser un texte exporté
Remettez d’aplomb un Markdown copié depuis une autre application, avec des puces et des espacements disparates.
Exemples
Titres, puces et lignes vides
L’espace du titre est ajoutée, les puces sont uniformisées et les trois lignes vides n’en font plus qu’une.
Entrée
#Titre
* premier point
+ second point
Texte finalRésultat
# Titre
- premier point
- second point
Texte finalCode et séparateur protégés
Rien ne change : le commentaire est dans un bloc de code, --- est un séparateur et **Important** n’est pas une puce.
Entrée
```bash
#commentaire
```
---
**Important** : à relireRésultat
```bash
#commentaire
```
---
**Important** : à relireConseils et bonnes pratiques
- Fermez chaque bloc de code par ``` : un bloc resté ouvert protège tout le reste du document, qui ne sera alors plus formaté.
- Une ligne commençant par « #mot » devient un titre « # mot » : si vous écrivez des hashtags en début de ligne, ajoutez un caractère avant ou vérifiez le résultat.
- Contrôlez ensuite le rendu avec l’Aperçu Markdown, surtout pour les listes imbriquées et les tableaux.
Sources et références
- CommonMark Specification 0.31.2 (s’ouvre dans un nouvel onglet), CommonMarkPage en anglais
Questions fréquentes
Que modifie exactement le formateur ?
Quatre choses : l’espace après les # des titres, les puces « * » et « + » remplacées par « - », les lignes vides successives réduites à une seule et les espaces de fin de ligne supprimées.
Mes blocs de code sont-ils modifiés ?
Non. Tout ce qui se trouve entre deux délimiteurs ``` ou ~~~ est conservé caractère par caractère, lignes vides comprises.
Les sauts de ligne forcés sont-ils conservés ?
Oui. Deux espaces ou plus après un texte, qui forcent un retour à la ligne en Markdown, sont ramenées à exactement deux espaces au lieu d’être supprimées.
Les listes numérotées sont-elles renumérotées ?
Non. Les numéros sont laissés tels qu’ils sont écrits ; seules les puces non numérotées sont uniformisées.
Puis-je l’utiliser dans un Pipeline ?
Oui. Le formatage peut s’enchaîner avec d’autres traitements de texte, par exemple avant une conversion du Markdown en HTML.
Outils associés
Continuez avec ces outils
Des outils similaires ou complémentaires à celui-ci.
Outils similaires
Générez du faux texte Lorem Ipsum pour vos maquettes, prototypes et tests de mise en page.
Texte & rédactionMis en avantUtiliser l’outil
Créez des noms de marque, de produit, de projet ou de domaine - pas des noms de personnes.
Texte & rédactionUtiliser l’outil
Rédigez du Markdown et affichez instantanément le rendu HTML.
Texte & rédactionUtiliser l’outil