简介
在编写 Markdown 文档时，我们往往会使用一些图标和特殊字符来美化文本以及在代码中使用一些语法高亮插件来让代码更加美观易读。但是，当我们在使用这些插件时，会有一些问题存在，比如有些插件会干扰 Markdown 原有的语法，导致文档排版出现问题，或者在使用这些插件时，插件在 GitHub 上预览时无法正常显示。
为了解决这些问题，一些前端开发者开发了 adjust-md-for-publish 这个 npm 包，它可以很好地解决这些问题，并且没有过多依赖。
安装
通过 npm 安装 adjust-md-for-publish：
npm install --save-dev adjust-md-for-publish
使用
adjust-md-for-publish 的使用非常简单，只需要执行以下命令即可：
adjust-md-for-publish ./path/to/mdfiles
其中，./path/to/mdfiles 是 Markdown 文件的目录，执行该命令后，adjust-md-for-publish 会扫描该目录下的所有 Markdown 文件，然后进行相应的处理。
特性
adjust-md-for-publish 有以下特性：
- 自动删除 Markdown 文件中的行末空格
- 自动替换 HTML 标签中的符号
- 删除 Markdown 文件中的多余空行
- 删除预处理语法
实例
为了更好地理解 adjust-md-for-publish 的使用方法，我们来看一个示例代码。
在 GitHub 上预览 Markdown 文件时，如果该 Markdown 文件中存在 LaTeX 公式，那么在预览时就不能正常显示，需要使用 $ 符号将 LaTeX 公式括起来，例如：
The Pythagorean Theorem is expressed by the equation a^2$+$b^2$=c^2 where a and b are the lengths of the two legs opposite the right angle, and c is the length of the hypotenuse.
这样，该公式才能正常显示。但是，在本地编辑 Markdown 文件，在使用 $ 符号括起 LaTeX 公式时，这些公式在预览时也不能正常显示。此时，我们可以使用 adjust-md-for-publish 进行处理。
在安装 adjust-md-for-publish 后，我们可以在终端中进入 Markdown 文件所在的目录，然后执行以下命令：
adjust-md-for-publish .
这样，adjust-md-for-publish 就会对该目录下的所有 Markdown 文件进行处理，消除其中的预处理语法和 LaTeX 公式符号问题。
以上就是 adjust-md-for-publish 的简单使用教程，希望对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/71093