MDX formatētājs
Sakārtojiet MDX dokumentus ar šo MDX formatētāju. Ielīmējiet MDX ar importiem, eksportiem, JSX komponentiem un Markdown, un rīks noņems tukšās rindas dokumenta sākumā un beigās, kā arī izlīdzinās katru cauruļsvītru tabulu, pielāgojot šūnu platumu kolonnai un no jauna izveidojot atdalītāja rindu ar tās līdzinājuma kolu zīmēm. Importi, komponenti un izteiksmes paliks tieši tādi, kā uzrakstīts, lai dokumentācijas autori iegūtu kārtīgas tabulas, nesabojājot būvēšanu.
Bieži uzdotie jautājumi
Ko maina MDX formatētājs?
Tas izlīdzina cauruļsvītru tabulas un noņem tukšās rindas un atstarpes dokumenta sākumā un beigās. Viss pārējais, tostarp Markdown teksts, importi, eksporti un JSX, tiek saglabāts tieši tā, kā uzrakstīts.
Vai tiek skarti importi, eksporti un JSX komponenti?
Nē, importa un eksporta priekšraksti, komponentu tagi, piemēram, <Callout type="info">, un izteiksmes figūriekavās tiek kopēti nemainīti. Formatētājs nekad nepārkārto kodu, tāpēc tas nevar sabojāt jūsu MDX būvēšanu.
Kā tiek formatētas tabulas?
Katrai rindai tiek pievienota sākuma un beigu cauruļsvītra, un katras šūnas platums ar atstarpēm tiek pielāgots platākajai šūnai attiecīgajā kolonnā, bet minimālais platums ir trīs rakstzīmes. Atdalītāja rinda tiek izveidota no jauna ar atbilstoša garuma domuzīmēm.
Vai tabulu līdzinājums tiek saglabāts?
Jā, atdalītāja rindas līdzinājuma kolu zīmes, piemēram, :---, :---: un ---:, tiek saglabātas. Kreisais, centrētais un labais kolonnu līdzinājums pēc formatēšanas izskatās tāpat.
Vai koda bloki tiek mainīti?
Nē, saturs starp trim atpakaļapostrofu vai trīs tildes norobežotājiem paliek nemainīts. Rindas ar cauruļsvītrām koda blokos nekad netiek uzskatītas par tabulām.
Kāpēc dažas tabulas kolonnas ir platākas, nekā gaidīts?
Platumi tiek skaitīti UTF-8 baitos, tāpēc diakritiskās zīmes un emocijzīmes tiek skaitītas kā vairāk nekā viena rakstzīme. Papildu atstarpes redzamas tikai pirmkodā; attēlotā tabula izskatās tāpat.
Vai tas formatē JavaScript, kas ir manā MDX?
Nē, imports, eksports un izteiksmes netiek pārformatēti. Formatējiet lielākus koda blokus atsevišķi, izmantojot JavaScript vai JSX formatētāju.
Ar ko tas atšķiras no Markdown formatētāja?
Abi izmanto vienus un tos pašus noteikumus; šis rīks atzīmē rezultātu kā mdx. Izmantojiet to .mdx failiem Docusaurus, Next.js, Astro vai līdzīgās dokumentācijas vidēs.
Kāpēc rezultāts ir ievietots mdx koda blokā?
Izvade tiek atgriezta koda blokā ar atzīmi mdx, tāpēc, ielīmējot to Markdown, tā tiek parādīta kā pirmkods. Kopējiet rindas starp ārējām koda bloka atzīmēm savā .mdx failā.
Cik liels var būt mans dokuments?
Līdz 5 MB vienā reizē; lielāka ievade tiek noraidīta ar ziņojumu. Izvade ir identiska Code Formatter opcijai MDX.