Le Markdown est un balisage qui se lit à l'œil nu, et le format que les modèles de langage lisent le mieux. Le JSON est un arbre de données fait d'objets, de listes, de nombres et de chaînes. pandoc se tient entre les deux, et cette page dit exactement ce qui arrive à un fichier MD en route vers le JSON.
Ce qui s'exécute quand un fichier MD devient un JSON
pandoc en deux passes, sur une machine que nous louons et que nous surveillons. Votre fichier MD est envoyé une fois, pandoc s'exécute une fois, le fichier JSON revient, et aucun des deux fichiers n'est conservé. MD vers JSON fait partie des 3649 paires sur lesquelles ce moteur a été sondé avec un vrai fichier, et c'est pour cela que cette page existe quand celles que la sonde n'a pas su prouver n'existent pas.
Ce qui survit du fichier MD dans le fichier JSON
Les listes du fichier MD, imbrications comprises, plus les blocs de code, les citations et les liens, tous réexprimés en JSON.
Les images : pandoc les extrait du fichier MD vers un répertoire de travail et les réintègre dans le JSON, si bien que rien ne finit par pointer vers un fichier qui n'existe plus.
Ce que la conversion MD vers JSON vous coûte
Les tableaux. Le rédacteur JSON ne sait pas en porter, et la sonde l'a découvert à la dure : un fichier CSV, qui n'est rien d'autre qu'un tableau, est revenu en JSON bien formé et complètement vide, avec un code de retour nul. Le moteur refuse désormais ce cas net plutôt que de vous remettre le vide.
Si un modèle doit lire le fichier JSON
La structure est ce qui subsiste du fichier MD, et la structure est ce dont un modèle a besoin. MD en entrée, JSON en sortie, avec l'arbre des titres intact plutôt qu'aplati en un seul long paragraphe.
MD vers JSON, mesuré plutôt que promis
En passant MD vers JSON sur le moteur réel avec un vrai fichier, pandoc a écrit 1 726 octets au format JSON en moins d'un dixième de seconde, machine par ailleurs au repos. C'est un fichier MD un jour donné et non une moyenne, et c'est pourquoi le nombre est donné avec le fichier qui l'a produit.
Le verdict MD vers JSON a été obtenu par un aller-retour pandoc, c'est-à-dire que la sortie a été relue par pandoc et devait encore contenir un mot témoin planté dans la source, ce qui prouve que le contenu a voyagé et pas seulement le conteneur. Le contrôle employé compte, parce qu'ils ne prouvent pas tous la même chose, et un code de statut 200 ne prouve strictement rien sur ce que le fichier JSON contient.
Le même fichier MD, envoyé ailleurs
Les autres sorties que la sonde a mesurées à partir d'un fichier MD, pour que le coût du choix du format JSON se lise face à quelque chose. Les tailles ne se comparent pas d'un moteur à l'autre, chaque famille ayant été sondée avec son propre fichier témoin MD.
MD vers PDF : 25 764 octets en 1,9 secondes, vérifié par une signature de format.
MD vers DOCX : 10 106 octets en 0,1 secondes, vérifié par un aller-retour pandoc.
MD vers EPUB : 5 034 octets en 0,1 secondes, vérifié par un aller-retour pandoc.
MD vers TXT : 264 octets en moins d'un dixième de seconde, vérifié par la relecture du texte.
MD vers HTML : 4 018 octets en 0,1 secondes, vérifié par un aller-retour pandoc.
MD vers RTF : 687 octets en moins d'un dixième de seconde, vérifié par un aller-retour pandoc.
Les autres routes vers JSON, et ce qu'elles ont mesuré
Parmi les routes publiées vers JSON, MD est la quatrième plus grosse sortie des 8 mesurées. Les fichiers témoins diffèrent : ce classement porte sur la sonde et non sur votre document.
ODT vers JSON : 1 761 octets en 0,1 secondes.
RTF vers JSON : 1 743 octets en 0,1 secondes.
TXT vers JSON : 1 343 octets en moins d'un dixième de seconde.
CSV vers JSON : 110 octets en moins d'un dixième de seconde.
YAML vers JSON : 110 octets en moins d'un dixième de seconde.
Ce que nous ne prétendrons pas sur MD vers JSON
Un fichier MD de plus de 25 Mo est refusé avant la fin de l'envoi plutôt qu'après, pour que vous n'attendiez pas un refus.
Une conversion MD vers JSON qui dépasse 60 secondes est tuée, et le processus pandoc avec elle. Une exécution abandonnée resterait posée sur l'un des deux cœurs de la machine jusqu'à ce que quelqu'un le remarque.
32 des 935 paires sondées dans la famille qui sert MD vers JSON ont échoué, et celle-ci n'en fait pas partie. Elles échouent pour des raisons qu'il vaut mieux connaître : un rédacteur incapable de porter ce dont le document est fait, ou une sortie que le moteur n'a pas su relire. Elles sont comptées ici plutôt que cachées, parce qu'une paire qui échoue en silence est pire qu'une paire qui échoue bruyamment.
pandoc n'écrit jamais le JSON en passant par un moteur TeX ici, et il n'écrit pas de PDF du tout : les onze moteurs qu'il lui faudrait ne sont pas sur cette machine, et une distribution TeX pèse plusieurs gigaoctets. Qui veut un PDF à partir d'un fichier MD passe par LibreOffice ou par calibre, qui en sont réellement capables.
Un fichier MD à la fois, choisi dans le navigateur. Il n'y a rien d'autre à régler et rien d'autre à proposer.
MD vers JSON : les questions que l'on pose
Qu'est-ce qui convertit vraiment mon fichier MD en JSON ?
C'est pandoc qui s'en charge, en deux passes, sur une machine que nous louons et que nous surveillons. Ni astuce de navigateur, ni service d'un tiers : le fichier MD est envoyé une fois, pandoc s'exécute une fois, le JSON revient, et aucun des deux fichiers n'est conservé ensuite.
Combien de temps prend une conversion MD vers JSON ?
Sur le fichier utilisé par la sonde, pandoc a mis moins d'un dixième de seconde et écrit 1 726 octets de JSON. C'est une mesure réelle sur un fichier MD réel, pas une moyenne et pas une promesse sur le vôtre : un MD plus gros prend plus longtemps, et au-delà de 60 secondes l'exécution est arrêtée.
Qu'est-ce que je perds en passant du MD au JSON ?
Celle qu'il faut connaître en premier : les tableaux. Le rédacteur JSON ne sait pas en porter, et la sonde l'a découvert à la dure : un fichier CSV, qui n'est rien d'autre qu'un tableau, est revenu en JSON bien formé et complètement vide, avec un code de retour nul. Le moteur refuse désormais ce cas net plutôt que de vous remettre le vide.
Les tableaux de mon fichier MD sont-ils encore des tableaux dans le JSON ?
Non, et c'est une propriété du JSON plutôt qu'un défaut de ce chemin. Le JSON ne sait pas porter de tableau : un fichier MD bâti autour d'un tableau est donc le mauvais candidat pour cette paire.
La conversion MD vers JSON est-elle gratuite ?
Il y a une franchise gratuite chaque mois, et une conversion MD vers JSON coûte un demi-crédit dessus. Quand la franchise est épuisée, l'outil le dit et s'arrête, plutôt que de vous remettre discrètement un JSON moins bon.