在前端开发中，我们经常需要编写文档来进行代码的说明和呈现，而 Markdown 是一种轻量级标记语言，可以帮助我们更快捷、方便地编写高质量的文档。但是，如何将 Markdown 编写的文档转化为 HTML 或者 PDF 格式的文件呢？这时候，一个叫做 sharemd-cli 的 npm 包就可以帮助我们实现这个过程。
什么是 sharemd-cli
npm 是 JavaScript 的包管理工具，可以根据需求安装、升级、卸载以及管理依赖的软件包。而 sharemd-cli 就是一个 npm 包，它能够将 Markdown 文件转化为 HTML 或者 PDF 格式并保存在本地，让我们编写的文档更方便地与他人共享和阅读。
安装 sharemd-cli
在使用 sharemd-cli 之前，我们需要先安装这个 npm 包。我们可以在命令行中输入以下指令进行安装：
--- ------- ----------- --
sharemd-cli 是一个全局安装的 npm 包，加入 -g 参数可以将其安装到我们的本地全局环境中，方便我们在任何位置使用。
使用 sharemd-cli
安装完成后，我们就可以开始使用 sharemd-cli 来将 Markdown 文件转化为 HTML 或者 PDF 格式了。先看下 sharemd-cli 的使用命令：
------- --------- ------------ -------------
其中：
options表示 sharemd 提供的一些可选项，如-h可以查看帮助信息。input-file表示要转化的 Markdown 文件的路径。output-file表示生成的 HTML 或者 PDF 文件的路径。
我们可以在命令行中输入以下指令进行转化：
------- ----------------- --------------------
或者：
------- ----------------- -------------------
如果只传递了一个路径参数，则 sharemd 将生成 HTML 文件，文件名将与 Markdown 文件的文件名相同，但扩展名为 .html。
使用示例
现在我们来编写一个 Markdown 文件，例如叫做 README.md，内容如下：
- ------ ------
然后，在命令行中输入以下指令：
------- --------- -----------
这时候，sharemd 会将 Markdown 文件转化为 HTML，并将其保存在当前目录下的 README.html 文件中。
我们可以在浏览器中打开这个 HTML 文件，就能够看到 Markdown 文件转化后的内容了。
总结
sharemd-cli 可以帮助我们将 Markdown 文件转化为 HTML 或者 PDF 格式的文档，方便我们进行文档的呈现和分享。在实际应用中，我们也可以使用其他类似的工具，如 marked、pandoc 等，来实现 Markdown 文件的转化。熟练掌握这些工具，对我们进行文档编写与管理都有很大的帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055b7f81e8991b448d90c4