Formatter MDX
Riordinate i documenti MDX con questo Formatter MDX. Incollate MDX con import, export, componenti JSX ed espressioni Markdown: lo strumento rimuove le righe vuote esterne del documento e riallinea tutte le tabelle con pipe, riempiendo le celle fino alla larghezza della colonna e ricreando la riga separatrice con i relativi due punti di allineamento. Import, componenti ed espressioni rimangono esattamente come scritti, così chi crea documentazione ottiene tabelle ordinate senza compromettere la compilazione.
Domande frequenti
Che cosa modifica il Formatter MDX?
Riallinea le tabelle con pipe e rimuove le righe vuote e gli spazi all'inizio e alla fine del documento. Tutto il resto, incluso il testo Markdown, gli import, gli export e JSX, rimane esattamente come scritto.
Gli import, gli export e i componenti JSX vengono modificati?
No, le istruzioni di import ed export, i tag dei componenti come <Callout type="info"> e le espressioni tra parentesi graffe vengono copiati senza modifiche. Il formatter non riformatta mai il codice, quindi non può compromettere la compilazione di MDX.
Come vengono formattate le tabelle?
Ogni riga riceve una pipe iniziale e una finale; ogni cella viene riempita fino alla larghezza della cella più ampia della colonna, per un minimo di tre caratteri. La riga separatrice viene ricreata con trattini della larghezza corrispondente.
Gli allineamenti delle tabelle vengono mantenuti?
Sì, i due punti di allineamento nella riga separatrice, come :---, :---: e ---:, vengono mantenuti. Dopo la formattazione, le colonne allineate a sinistra, al centro e a destra vengono visualizzate allo stesso modo.
I blocchi di codice vengono modificati?
No, il contenuto tra delimitatori composti da tre backtick o tre tilde rimane invariato. Le righe con pipe nei blocchi di codice non vengono mai trattate come tabelle.
Perché alcune colonne della tabella sono più larghe del previsto?
Le larghezze sono conteggiate in byte UTF-8, quindi le lettere accentate e le emoji contano come più di un carattere. Il padding extra è visibile solo nel sorgente; la tabella visualizzata appare uguale.
Perché non formatta JavaScript all'interno del mio MDX?
No, il codice negli import, negli export e nelle espressioni non viene riformattato. Formattate separatamente i blocchi di codice più grandi con JavaScript o il Formattatore JSX.
Qual è la differenza rispetto al Formattatore Markdown?
Entrambi applicano le stesse regole; questo strumento contrassegna il risultato come mdx. Usatelo per i file .mdx in Docusaurus, Next.js, Astro o configurazioni di documentazione simili.
Perché il risultato è racchiuso in un blocco di codice mdx?
L'output viene restituito all'interno di un blocco di codice contrassegnato come mdx, quindi quando lo incollate in Markdown viene visualizzato come sorgente. Copiate le righe tra i delimitatori esterni nel vostro file .mdx.
Qual è la dimensione massima del documento?
Fino a 5 MB per esecuzione; gli input più grandi vengono rifiutati con un messaggio. L'output è identico a quello dell'opzione MDX del Formattatore di codice.