Форматиращ инструмент за MDX
Почистете документи MDX с този форматиращ инструмент за MDX. Поставете MDX с импорти, експорти, компоненти JSX и Markdown и инструментът ще премахне външните празни редове в документа и ще подравни отново всяка таблица с вертикални черти, като допълни клетките до ширината на колоната и изгради наново разделителния ред с двоеточията за подравняване. Импортите, компонентите и изразите остават точно така, както са написани, така че авторите на документацията получават подредени таблици, без да повреждат компилацията.
Често задавани въпроси
Какво променя форматиращият инструмент за MDX?
Той подравнява отново таблиците с вертикални черти и премахва празните редове и интервалите от началото и края на документа. Всичко останало, включително текстът Markdown, импортите, експортите и JSX, се запазва точно така, както е написано.
Променят ли се импортите, експортите и компонентите JSX?
Не, операторите за импорт и експорт, таговете на компоненти като <Callout type="info"> и изразите във фигурни скоби се копират без промяна. Форматиращият инструмент никога не пренарежда кода, така че не може да повреди компилацията ви MDX.
Как се форматират таблиците?
Всеки ред получава начална и крайна вертикална черта, а всяка клетка се допълва до ширината на най-широката клетка в колоната, минимум три знака. Разделителният ред се изгражда наново със съответния брой тирета.
Запазва ли се подравняването на таблиците?
Да, двоеточията за подравняване в разделителния ред, например :---, :---: и ---:, се запазват. Ляво, центрирано и дясно подравнените колони се визуализират по същия начин след форматирането.
Променят ли се кодовите блокове?
Не, съдържанието между ограждения от три обратни апострофа или три тилди остава непроменено. Редовете с вертикални черти в кодови блокове никога не се третират като таблици.
Защо някои колони в таблицата са по-широки от очакваното?
Ширината се брои в UTF-8 байтове, затова ударените букви и емоджитата се броят като повече от един знак. Допълнителните интервали се виждат само в изходния код; визуализираната таблица изглежда по същия начин.
Форматира ли код JavaScript в моя MDX?
Не, кодът в импортите, експортите и изразите не се форматира отново. Форматирайте отделно по-големите кодови блокове с форматиращия инструмент за JavaScript или JSX.
Каква е разликата спрямо форматиращия инструмент за Markdown?
И двата прилагат едни и същи правила; този инструмент маркира резултата като mdx. Използвайте го за файлове .mdx в Docusaurus, Next.js, Astro или подобни среди за документация.
Защо резултатът е ограден с блок за код mdx?
Резултатът се връща в кодов блок, маркиран като mdx, така че при поставяне в Markdown да се показва като изходен код. Копирайте редовете между външните ограждения във вашия файл .mdx.
Колко голям може да бъде документът ми?
До 5 MB на изпълнение; по-големият вход се отхвърля със съобщение. Резултатът е идентичен с опцията MDX на форматиращия инструмент за код.