md-padding
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

Markdown Padding

npm version downloads Check Release Coveralls semantic-release GitHub issues DUB license Commitizen friendly

排版中只有空格不能忍,修复你 Markdown 中缺少的空格:

  • 中英文混排时,中文英文 之间,中文数字 之间添加空格。
  • 特定英文标点 后面添加空格,但 全角标点 前后不加空格。
  • 文字和 行内代码 之间、文字与 链接 之间、文字与 加粗强调删除线 之间添加空格。
  • 会解析生成 Markdown + 自然语言构成的 AST,最大限度解决问题同时避免误处理。

这里 有个例子:

raw.md 和 formated.md 之间的 Diff

使用说明

在命令行使用

可以 npm i -g md-padding 后使用,也可以用 npx md-padding

# 输出 README.md 格式化后的内容
npx md-padding README.md

还可以接受标准输入(用在管道中),也可以原址(in-place)更改文件。详见 md-padding --help

> npx md-padding --help
md-padding [OPTION]... <FILE>

Options:
  --help, -h      Show help                  [boolean]
  --version       Show version number        [boolean]
  --in-place, -i  edit file in place         [boolean]

Examples:
  stdout    md-padding README.md
  in-place  md-padding -i README.md
  pipe      cat README.md | md-padding

在 Vim 中使用

可以绑定一个快捷键 F6 来修复当前文件:

" 绑一个 Vim Filter
noremap <buffer> <F6> <Esc>:%!npx md-padding<CR>

在 VS Code 中使用

从 Marketplace 安装 Markdown Padding。 打开一个 Markdown 文件后,支持这些操作:

  • Command。打开 命令面板,输入 Markdown Padding 并回车。命令面板 快捷键:
    • Windows:Ctrl + Shift + P
    • Mac:Command + Shift + P
    • Linux:Ctrl + Shift + P
  • Formatting。在编辑器里右键点格式化,或者:
    • Windows:Shift + Alt + F
    • Mac:Shift + Option + F
    • Linux:Ctrl + Shift + I

支持说明

中英混排

中英混排的正文内容,会确保中英之间的空格。

标点符号

需要空格的标点(比如半角逗号),会在适当的位置追加空格。

代码注释

代码格式化不是本仓库的功能之一,请使用对应语言的 prettifier。但代码中的注释会被当做 Markdown 正文来格式化,目前支持这些语言的注释:

  • cpp, c, java, javascript, typescript, csharp, go
  • sql
  • bash, python, ruby

Readme

Keywords

none

Package Sidebar

Install

npm i md-padding

Weekly Downloads

3

Version

1.4.0

License

MIT

Unpacked Size

613 kB

Total Files

144

Last publish

Collaborators

  • harttle