如何让Prettier格式化Markdown时不在注释后自动新增空行
解决方案
保留Prettier使用的调整方法
- 局部特殊场景处理:如果仅少量位置存在注释后接标题的场景,可以给对应区块增加Prettier忽略标记,就能保留原有格式不被自动加空行,其他区域的80字符自动换行、常规格式化功能不受影响,示例写法:
<!-- prettier-ignore-start --> <!-- omit in toc --> ## Title name <!-- prettier-ignore-end -->
- 全局规则调整:目前Prettier官方没有单独配置「注释和标题之间是否保留空行」的内置选项,如果需要全局禁用该自动加空行逻辑,可以搭配第三方Prettier的markdown自定义规则插件,自行调整元素间距规则,不过需要额外写插件配置,操作复杂度更高。
仅需80字符自动换行的替代VSCode工具
如果不想修改Prettier配置,可以换用下面两款插件,只会按照指定宽度拆分长文本,不会额外新增空行:
- Rewrap:专门做文本按宽度折行的轻量插件,默认折行宽度为80字符,完全不会修改现有行间距、空行、元素格式,可配置为markdown文件的默认格式化工具,也可通过快捷键手动触发折行。
- Markdown All in One:常用的markdown功能增强插件,关闭内置的其他格式化规则后,仅开启自动按宽度换行功能即可实现需求,不会额外生成空行。
内容的提问来源于stack exchange,提问作者lklklklkpopopo
相关产品推荐
相关产品推荐

