Formateur MDX
Nettoyez les documents MDX avec ce formateur MDX. Collez du MDX avec des imports, des exports, des composants JSX et des Markdown : l'outil supprime les lignes vides au début et à la fin du document, puis réaligne chaque tableau à barres verticales en ajustant les cellules à la largeur de leur colonne et en recréant la ligne de séparation avec ses deux-points d'alignement. Les imports, composants et expressions restent exactement tels qu'ils ont été écrits ; les auteurs de documentation obtiennent ainsi des tableaux propres sans compromettre la compilation.
Foire aux questions
Que modifie le formateur MDX ?
Il réaligne les tableaux à barres verticales et supprime les lignes vides ainsi que les espaces au début et à la fin du document. Tout le reste, y compris le texte Markdown, les imports, les exports et JSX, est conservé exactement tel qu'il a été écrit.
Les imports, les exports et les composants JSX sont-ils modifiés ?
Non, les instructions d'import et d'export, les balises de composant telles que <Callout type="info"> et les expressions entre accolades sont copiées sans modification. Le formateur ne reformate jamais le code et ne peut donc pas compromettre votre compilation MDX.
Comment les tableaux sont-ils formatés ?
Chaque ligne reçoit une barre verticale au début et à la fin, et chaque cellule est complétée jusqu'à la largeur de la cellule la plus large de sa colonne, avec un minimum de trois caractères. La ligne de séparation est recréée avec des tirets correspondants.
Les alignements des tableaux sont-ils conservés ?
Oui, les deux-points d'alignement de la ligne de séparation, tels que :---, :---: et ---:, sont conservés. Les colonnes alignées à gauche, au centre et à droite s'affichent de la même façon après le formatage.
Les blocs de code sont-ils modifiés ?
Non, le contenu situé entre des clôtures de trois accents graves ou de trois tildes est conservé tel quel. Les lignes contenant des barres verticales dans les blocs de code ne sont jamais traitées comme des tableaux.
Pourquoi certaines colonnes du tableau sont-elles plus larges que prévu ?
Les largeurs sont comptées en octets UTF-8 : les lettres accentuées et les emoji comptent donc pour plus d’un caractère. Le remplissage supplémentaire n’apparaît que dans le code source ; le tableau rendu reste identique.
Formate-t-il le JavaScript dans mon MDX ?
Non, le code des imports, des exports et des expressions n’est pas reformaté. Formatez séparément les blocs de code plus importants avec le formateur JavaScript ou JSX.
Quelle est la différence avec le formateur Markdown ?
Les deux appliquent les mêmes règles ; cet outil marque son résultat comme mdx. Utilisez-le pour les fichiers .mdx dans Docusaurus, Next.js, Astro ou des configurations de documentation similaires.
Pourquoi le résultat est-il encadré par une clôture de code mdx ?
La sortie est renvoyée dans un bloc de code marqué mdx : elle s’affiche donc comme du code source lorsque vous la collez dans Markdown. Copiez les lignes situées entre les clôtures extérieures dans votre fichier .mdx.
Quelle peut être la taille de mon document ?
Jusqu’à 5 MB par exécution ; les entrées plus volumineuses sont rejetées avec un message. La sortie est identique à celle de l’option MDX du formateur de code.