Форматувач 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 форматера коду.