前言
有时候在撰写 Markdown 文件时，由于失误或不注意，标题的前后会出现多余的空格，导致文本呈现不佳。而使用 remark-lint-heading-whitespace 这个 npm 包，便可以轻易地检测出这些问题，让你的 Markdown 文件更加整洁美观。
安装
在使用 remark-lint-heading-whitespace 之前，需要先安装 Node.js 和 npm 包管理器。在安装好这些前置条件后，可以使用以下命令安装 remark-lint-heading-whitespace：
--- ------- -- ---------- ----------- ------------------------------
使用
安装好 remark-lint-heading-whitespace 后，可以在终端中输入以下命令来检测一个 Markdown 文件中的标题是否存在多余的空格：
------ ----------- ----------------- ------------------------------------ ---------------------
其中，your-markdown-file.md 换成你需要检测的 Markdown 文件名。
若无多余空格，命令行则不会产生任何输出。若存在多余的空格，则会输出类似以下的错误信息：
--------------------- --- ----- ------ - ------- ----- ---- ----------------
其中，1:1 表示错误出现在哪个位置（第1行第1列），error 表示出现了错误，Remove 1 leading blank line 则是具体的错误信息。
若需要自定义该 npm 包的配置，可以在 Markdown 文件所在的根目录下创建一个名为 .remarkrc.js 文件，该文件需要返回一个包含该 npm 包配置信息的 JavaScript 对象，例如：
-------------- - -
-------- -
---------------------
---------------------------------- --------
-
-此处配置信息代表：切换至 remark-preset-lint 插件预设（此预设包含许多预定义的 Markdown 格式化规则），并禁止使用多余空格。
总结
使用 npm 包 remark-lint-heading-whitespace 可以轻松地检测 Markdown 文件中的标题是否存在多余的空格，使文本更加整洁美观。在使用过程中，要注意正确安装 Node.js 和 npm 包管理器，并掌握正确的命令行操作。同时，可以进行自定义配置以适应不同的文档格式要求。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedae1db5cbfe1ea0610d7e