Ce qu’un nettoyeur de Markdown jette, et comment le garder

« Retirer le Markdown » sonne comme une opération unique. C’est en réalité une série de petites décisions, et un convertisseur les prend toutes à votre place, qu’il l’avoue ou non.

Voici ce qui est habituellement mal décidé.

La numérotation des listes

La plus lourde de conséquences. Les bibliothèques courantes traitent une liste comme une construction de mise en forme et l’aplatissent, ce qui supprime 1. 2. 3. en même temps que les caractères de puce.

Pour une liste à puces, cela se défend. Pour une liste numérotée, cela en détruit le sens : les numéros renvoyaient à quelque chose. Réponses à un questionnaire numéroté, étapes d’une séquence, éléments classés — tout devient un tas non ordonné.

La numérotation est conservée ici, y compris pour les listes qui commencent à 7, et y compris pour une liste numérotée imbriquée dans une autre.

L’URL derrière un lien

[la doc](https://example.com/guide) contient deux informations. Le texte brut n’a nulle part où mettre la seconde ; un convertisseur doit donc soit l’écrire, soit l’abandonner.

L’abandonner est silencieux et fréquent. Le lecteur reçoit « la doc » et aucun moyen d’y accéder. Le réglage par défaut écrit ici les deux — la doc (https://example.com/guide) — parce qu’un lecteur qui ne peut pas suivre le lien a perdu quelque chose. Texte seul et URL seule restent disponibles quand vous savez que le lien n’a pas d’importance.

Le langage d’un bloc de code

Un bloc marqué ```java porte un fait : ceci est du Java. Retirez la marque et ce fait part avec elle, laissant un bloc de symboles inexpliqués qui pourraient être n’importe quoi.

Le langage est émis sous forme d’étiquette — [java] — pour que le lecteur sache. Désactivé, ou conservé sous forme de marque d’origine, si vous préférez.

Le texte alternatif d’une image

Une image ne peut pas survivre en tant qu’image. Mais son texte alternatif est une phrase que quelqu’un a écrite pour la décrire, et c’est souvent la seule description de ce contenu dans le document. Écarter l’image et garder la description vaut généralement mieux qu’écarter les deux.

Notes de bas de page, citations, séparateurs, frontmatter

Chacun est un contenu qu’un nettoyeur peut supprimer sans rien dire. Chacun est conservé par défaut ici et désactivable individuellement.

Pourquoi le sans-perte est le bon réglage par défaut

Le test qui règle la plupart de ces cas : un lecteur qui n’a jamais vu l’entrée pourrait-il comprendre tout ce qu’elle disait à partir de la seule sortie ?

Si la réponse est non, le convertisseur a jeté de l’information au nom du lecteur sans demander. Un convertisseur qui laisse quelque chose que vous devez supprimer vous-même est agaçant dix secondes. Un convertisseur qui supprime quelque chose dont vous aviez besoin est un problème que vous ne remarquerez peut-être qu’au moment où cela compte.

Les réglages par défaut gardent donc tout, et chaque suppression est un interrupteur que vous choisissez. Un préréglage — Rapport et tableaux — enfreint délibérément cette règle et retire les blocs de code et les images, parce qu’il existe pour faire passer un tableau comparatif dans un rapport où un extrait égaré est du bruit. C’est l’exception, il le dit, et le préréglage Par défaut ne retire strictement rien.

Les choses qui n’ont vraiment pas de réponse

Certaines décisions n’ont pas de bon réglage par défaut, seulement un contexte :

• À quoi ressemble un titre quand rien ne peut en faire un titre ? Brut, en majuscules, ou # conservé.
• À quoi ressemble un tableau sans tableau ? Colonnes alignées, tabulations, ou libellé-valeur.
• À quoi ressemble une liste de tâches ? [ ], ☐, ou rien.

C’est pour cela que les préréglages existent. Plutôt que d’en choisir un et de le déclarer universel, chaque préréglage répond à toutes ces questions pour une destination donnée — un client de messagerie, un tableur, une fenêtre de discussion, une page de documentation, un formulaire web — et vous montre un exemple pour que vous voyiez les réponses avant de leur faire confiance.