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