Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

prettier-plugin-lint-md

npm version CI MIT License

prettier-plugin-lint-md

让 Prettier 格式化后的 Markdown 符合中文排版规范。

为什么需要这个插件?

Prettier 3 不再自动在中文、日文与西文字符之间插入空格。这个决定适合 Prettier 的整体用户群体。中文技术文档通常仍希望保留这类排版规则。

Prettier 3 关于中西文空格的变更说明

这个插件会在 Prettier 格式化前调用 @lint-md/core,自动修复相关的中文排版问题。

相关讨论:Markdown: Add an option to re-enable Prettier 2.x's automatic space insertion in CJK

快速开始

安装插件:

pnpm add -D prettier prettier-plugin-lint-md

在 Prettier 配置中启用插件:

export default {
  plugins: ['prettier-plugin-lint-md'],
};

这就是完整的基础配置。插件默认启用全部 16 条可自动修复规则,包括中西文空格、数字空格、中文标点、省略号、空链接和代码块等常见问题。只有需要调整个别规则时,才需要添加额外配置。

安装、配置、默认规则和 Node.js API 请阅读完整文档

GitHub · 问题反馈 · 参与贡献 · 安全策略 · MIT License

About

基于 @lint-md 的 Prettier 格式化插件,让其符合中文编写规范。

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Used by

Contributors

Languages