Formatter MDX
Uporządkuj dokumenty MDX za pomocą tego formattera MDX. Wklej MDX z importami, eksportami, komponentami JSX i Markdown, a narzędzie usunie zewnętrzne puste wiersze dokumentu i wyrówna wszystkie tabele z pionowymi kreskami, dopasowując szerokość komórek do kolumn oraz tworząc ponownie wiersz separatora z zachowaniem dwukropków określających wyrównanie. Importy, komponenty i wyrażenia pozostaną dokładnie takie, jak zostały napisane, dzięki czemu autorzy dokumentacji otrzymają schludne tabele bez ryzyka zepsucia kompilacji.
Najczęściej zadawane pytania
Co zmienia formatter MDX?
Wyrównuje tabele z pionowymi kreskami oraz usuwa puste wiersze i spacje z początku i końca dokumentu. Cała pozostała zawartość, w tym tekst Markdown, importy, eksporty i JSX, pozostaje dokładnie taka, jak została napisana.
Czy importy, eksporty i komponenty JSX są zmieniane?
Nie, instrukcje importu i eksportu, znaczniki komponentów, takie jak <Callout type="info">, oraz wyrażenia w nawiasach klamrowych są kopiowane bez zmian. Formatter nigdy nie zmienia układu kodu, więc nie może zepsuć kompilacji MDX.
Jak formatowane są tabele?
Każdy wiersz otrzymuje pionowe kreski na początku i na końcu, a każda komórka jest dopełniana do szerokości najdłuższej komórki w kolumnie, wynoszącej co najmniej trzy znaki. Wiersz separatora jest tworzony ponownie z odpowiednią liczbą myślników.
Czy wyrównanie tabel jest zachowywane?
Tak, dwukropki określające wyrównanie w wierszu separatora, takie jak :---, :---: i ---:, pozostają bez zmian. Po formatowaniu kolumny wyrównane do lewej, do środka i do prawej renderują się tak samo.
Czy bloki kodu są zmieniane?
Nie, zawartość między blokami oznaczonymi trzema znakami backtick lub trzema tyldami pozostaje bez zmian. Wiersze z pionowymi kreskami wewnątrz bloków kodu nigdy nie są traktowane jak tabele.
Dlaczego niektóre kolumny tabeli są szersze, niż oczekiwano?
Szerokości są liczone w bajtach UTF-8, więc litery ze znakami diakrytycznymi i emoji zajmują więcej niż jeden znak. Dodatkowe dopełnienie widać tylko w kodzie źródłowym; wyrenderowana tabela wygląda tak samo.
Czy formatuje JavaScript wewnątrz mojego MDX?
Nie, kod w importach, eksportach i wyrażeniach nie jest formatowany ponownie. Większe bloki kodu formatuj osobno za pomocą JavaScript lub JSX Formatter.
Czym różni się od Markdown Formatter?
Oba narzędzia stosują te same reguły; to narzędzie oznacza wynik jako mdx. Używaj go do plików .mdx w Docusaurus, Next.js, Astro lub podobnych konfiguracjach dokumentacji.
Dlaczego wynik jest ujęty w blok kodu mdx?
Wynik jest zwracany w bloku kodu oznaczonym jako mdx, więc po wklejeniu do Markdown wyświetla się jako kod źródłowy. Skopiuj wiersze między zewnętrznymi ogrodzeniami kodu do pliku .mdx.
Jak duży może być mój dokument?
Do 5 MB na uruchomienie; większe dane wejściowe są odrzucane z komunikatem. Wynik jest identyczny z opcją MDX w Code Formatter.