前言
在日常前端开发中，我们经常需要将 markdown 格式的文档转换为 PDF 格式，以供分享或存档等目的。本文将介绍一种使用 npm 包 hyper-markdown-pdf 进行 markdown 转 PDF 的方法。
hyper-markdown-pdf 简介
hyper-markdown-pdf 是一个基于 markdown-it 和 puppeteer 的 npm 包，可以将 markdown 格式的文档渲染成 PDF 格式，并支持多种样式配置。
安装
本包需要 Node.js 环境支持，因此需要先安装 Node.js，安装方法可以参考官方文档 https://nodejs.org/en/
然后使用 npm 进行包的安装：
--- ------- -- ------------------
使用教程
命令行
hyper-markdown-pdf 提供了一个命令行工具 hmpdf 用于将 markdown 文件转换为 PDF 文件。以转换 example.md 为例，转换后的 PDF 文件名为 example.pdf：
----- ---------- -----------
如果需要自定义样式，则需要创建一个样式文件，例如 style.css，并将其作为参数传给 hmpdf 命令：
----- ---------- ----------- ------- ---------
样式文件可以参考 hyper-markdown-pdf 提供的默认样式文件 default.css 进行自定义。
JavaScript API
除了命令行工具之外，hyper-markdown-pdf 还提供了 JavaScript API，以便在代码中使用。以将 example.md 转换为 PDF 并保存为 example.pdf 为例：
----- ----- - ------------------------------
----- -- - --------------
----- -------- ------------- -
----- -- - ----------------------------- ---------
----- ------- - -
------- -----
------------- -------
----------- -------
------------ -------
---------- -------
------ ---------------------------- ---------
--
----- ------ - ----- --------- ---------
------------------------------- --------
-
--------------其中 options 参数可以设置 PDF 的格式和样式等，具体参数见 hyper-markdown-pdf 的文档。
总结
以上为 hyper-markdown-pdf 的使用教程，使用起来简单易懂，而且支持多种样式配置，非常适用于将 markdown 格式的文档转换为 PDF 格式。同时这也体现了 npm 包作为一种常用的前端工具的作用，在日常开发中能够为我们节省很多时间和精力。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005738481e8991b448e977a