MDX 格式化工具
使用此 MDX 格式化工具整理 MDX 文档。粘贴包含导入、导出、JSX 组件和 Markdown 的 MDX,工具会删除文档首尾的空行,并重新对齐每个管道表格,按列宽填充单元格,并根据对齐冒号重建分隔行。导入、组件和表达式都会保持原样,因此文档编写者可以获得整洁的表格,同时不影响构建。
常见问题
MDX 格式化工具会更改什么?
它会重新对齐管道表格,并删除文档开头和结尾的空行及空格。其他内容,包括 Markdown 文本、导入、导出和 JSX,都会保持原样。
导入、导出和 JSX 组件会被改动吗?
不会,导入和导出语句、例如 <Callout type="info"> 的组件标签,以及花括号中的表达式都会原样保留。格式化工具不会重新排版代码,因此不会破坏你的 MDX 构建。
表格如何格式化?
每一行都会添加开头和结尾的管道符,每个单元格会填充空格,使其达到所在列最宽单元格的宽度,且至少为三个字符。分隔行会用相应数量的短横线重新生成。
表格对齐方式会保留吗?
会,分隔行中的对齐冒号(例如 :---、:---: 和 ---:)都会保留。格式化后,左对齐、居中对齐和右对齐的列呈现效果不变。
代码块会被更改吗?
不会,三个反引号或三个波浪号围栏之间的内容会原样保留。代码块中含有管道符的行不会被当作表格处理。
为什么有些表格列比预期的更宽?
宽度按 UTF-8 字节数计算,因此带重音符号的字母和表情符号会计为多个字符。额外的填充只会显示在源文本中,渲染后的表格看起来不变。
它会格式化我的 MDX 中的 JavaScript 吗?
不会,导入、导出和表达式中的代码不会重新格式化。请使用 JavaScript 或 JSX 格式化工具,单独格式化较大的代码块。
它与 Markdown 格式化工具有什么区别?
两者应用相同的规则;此工具会将结果标记为 mdx。在 Docusaurus、Next.js、Astro 或类似文档配置中处理 .mdx 文件时,请使用此工具。
为什么结果会包在 mdx 代码围栏中?
输出会放在标记为 mdx 的代码块中,因此粘贴到 Markdown 时会显示为源文本。请将外层围栏之间的行复制到你的 .mdx 文件中。
我的文档最大可以有多大?
每次最多 5 MB;超过此大小的输入会被拒绝并显示提示。输出与 Code Formatter 的 MDX 选项完全相同。