Markdown 格式化工具
使用此 Markdown 格式化工具整理 Markdown。粘贴 README、文档页面或笔记后,工具会删除开头和结尾的空行,并重新对齐每个管道符表格:单元格会填充空格至所在列最宽条目的宽度,分隔行会用相应数量的短横线重新生成,同时保留对齐冒号。其他内容均按原样保留,让写作者和开发者能够获得整洁的表格,不必担心意外改动。
常见问题
Markdown 格式化工具会更改哪些内容?
它会重新对齐管道符表格,并删除文档开头和结尾的空行及空格。标题、段落、列表、链接和强调格式都会完全按照你的写法保留。
表格如何格式化?
每一行的开头和结尾都会添加管道符;每个单元格会填充空格,使其达到所在列最宽单元格的宽度;每列至少为三个字符宽。分隔行会用相同宽度的短横线重新生成。
列对齐方式会保留吗?
会,分隔行中的冒号会保留。以 :---、:---: 和 ---: 表示的左对齐、居中对齐和右对齐都会在重新格式化后保留。
代码块中的表格会被更改吗?
不会,三个反引号或三个波浪号围起来的内容都会保持不变。这也包括代码块中看起来像表格的文本。
为什么带重音字母或表情符号的列看起来没有对齐?
单元格宽度按 UTF-8 字节数计算,因此 ASCII 以外的字符会计为 2 到 4 个字节。在纯文本编辑器中,这些字符所在的列可能会多出一些填充空格,但渲染后的表格不会受到影响。
它会更改列表标记或标题样式吗?
不会,列表标记、编号、标题标记以及段落内的空格都会按原样保留。此格式化工具有意采用保守处理方式,因此绝不会改变文档的渲染效果。
格式化后的文档渲染效果会不同吗?
不会,填充表格单元格和删除文档首尾的空行都不会改变渲染结果。GitHub、GitLab 和其他渲染器在格式化前后显示的表格都相同。
我可以用它处理 MDX 文件吗?
可以,但 MDX 格式化工具更适合,因为它会将结果标记为 mdx。两者使用相同规则,并且都会保留导入语句和 JSX。
为什么结果会被包在 markdown 代码围栏中?
输出会放在标记为 markdown 的代码块中,因此粘贴到 Markdown 查看器时会显示为源文本。请将外围围栏之间的内容复制到你的 .md 文件中。
我的文档最大可以有多大?
每次运行最多支持 5 MB;超过此大小的输入会被拒绝并显示提示。输出与 Code Formatter 的 Markdown 选项完全一致。