MDX-Formatter
Räume MDX-Dokumente mit diesem MDX-Formatter auf. Füge MDX mit Imports, Exports, JSX-Komponenten und Markdown ein. Das Werkzeug entfernt die äußeren Leerzeilen des Dokuments und richtet jede Pipe-Tabelle neu aus, indem es Zellen auf ihre Spaltenbreite bringt und die Trennzeile mit den Ausrichtungsdoppelpunkten neu erstellt. Imports, Komponenten und Ausdrücke bleiben genau wie geschrieben erhalten. So bekommen Autoren übersichtliche Tabellen, ohne den Build zu beschädigen.
Häufig gestellte Fragen
Was ändert der MDX-Formatter?
Er richtet Pipe-Tabellen neu aus und entfernt Leerzeilen und Leerzeichen am Anfang und Ende des Dokuments. Alles andere, einschließlich Markdown-Text, Imports, Exports und JSX, bleibt genau wie geschrieben erhalten.
Werden Imports, Exports und JSX-Komponenten verändert?
Nein, Import- und Exportanweisungen, Komponenten-Tags wie <Callout type="info"> und Ausdrücke in geschweiften Klammern werden unverändert übernommen. Der Formatter formatiert Code nie um und kann daher deinen MDX-Build nicht beschädigen.
Wie werden Tabellen formatiert?
Jede Zeile erhält Pipes am Anfang und am Ende. Jede Zelle wird auf die Breite der breitesten Zelle ihrer Spalte gebracht, mindestens jedoch auf drei Zeichen. Die Trennzeile wird mit passenden Bindestrichen neu erstellt.
Bleiben die Tabellenausrichtungen erhalten?
Ja, Ausrichtungsdoppelpunkte in der Trennzeile, etwa :---, :---: und ---:, bleiben erhalten. Links-, zentrierte und rechtsbündige Spalten werden nach der Formatierung gleich dargestellt.
Werden Codeblöcke geändert?
Nein, Inhalte zwischen Zäunen aus drei Backticks oder drei Tilden bleiben unverändert. Zeilen mit Pipes in Codeblöcken werden nie als Tabellen behandelt.
Warum sind manche Tabellenspalten breiter als erwartet?
Breiten werden in UTF-8-Bytes gezählt, daher zählen Akzentbuchstaben und Emojis als mehr als ein Zeichen. Die zusätzlichen Abstände sind nur im Quelltext sichtbar; die Tabelle wird gleich dargestellt.
Formatiert das Werkzeug den JavaScript in meinem MDX?
Nein, Code in Imports, Exports und Ausdrücken wird nicht neu formatiert. Größere Codeblöcke kannst du separat mit dem JavaScript- oder JSX-Formatter formatieren.
Worin unterscheidet sich der Markdown-Formatter?
Beide wenden dieselben Regeln an; dieses Werkzeug kennzeichnet sein Ergebnis als mdx. Verwende es für .mdx-Dateien in Docusaurus, Next.js, Astro oder ähnlichen Dokumentationsumgebungen.
Warum ist das Ergebnis in einen mdx-Codeblock eingeschlossen?
Die Ausgabe wird in einem mit mdx gekennzeichneten Codeblock zurückgegeben und beim Einfügen in Markdown als Quelltext angezeigt. Kopiere die Zeilen zwischen den äußeren Zäunen in deine .mdx-Datei.
Wie groß darf mein Dokument sein?
Bis zu 5 MB pro Durchlauf; größere Eingaben werden mit einer Meldung abgelehnt. Die Ausgabe entspricht der Option MDX des Code Formatters.