简介
marked-renderer-pdf
是一个基于 marked
的 npm 包,可以将 markdown 文件转化为 PDF 文件,支持中文排版和不同的排版风格。
安装
在终端中使用以下命令安装:
npm install marked-renderer-pdf --save
使用方法
库引入
首先,在项目文件中引入 marked-renderer-pdf
库:
const MarkedRendererPdf = require("marked-renderer-pdf");
初始化
然后,需要初始化 MarkedRendererPdf
对象,以配置需要的参数。初始化方法如下:
const markedRenderer = new MarkedRendererPdf(options);
options
是一个 JSON 对象,可以配置如下参数:
basePath
:markdown 文件中图片等资源的相对路径,默认为 "./"。cssPath
:自定义 css 文件路径,可以通过准备一个本地的 css 文件来覆盖默认风格。debug
:是否启用调试模式,默认为 false。outputPath
:生成的 PDF 文件输出目录,默认为当前目录的 "./output/" 下。paperSize
:纸张大小,默认为 "A4",可选值为 "A3"、"A4"、"A5"、"Legal"、"Letter"。renderDelay
:渲染延时(单位毫秒),如果有大量的网络请求和图片加载等可以适当加长此参数。style
:排版风格,默认为标准中文格式("cn"),可选值为 "en"、"github"、"cobalt"、"monokai" 等风格。
方法调用
接下来,调用 markedRenderer.render(markdownText, options)
方法,将 markdown 文件渲染为 PDF 文件。方法中的 markdownText
为需要转化的 markdown 文本,options
是可选参数,包括 title
和 subtitle
,分别表示标题和副标题。
-- -------------------- ---- ------- ----- ------- - - ------ --------- --------- ---------- -- ------------------------ -------- -------- -------- -- - ---------------- ---------- -- ------------ -- - ------------------- ---
示例代码
-- -------------------- ---- ------- ----- ----------------- - ------------------------------- ----- -------------- - --- ------------------- ---------- ----- ------ ----- ------ ---- --- ----- ------- - - ------ --------- --------- ---------- -- ------------------------ -------- -------- -------- -- - ---------------- ---------- -- ------------ -- - ------------------- ---
总结
marked-renderer-pdf
是一个非常实用的 npm 包,可以帮助前端开发人员将 markdown 文件快速转化为 PDF 文件。此外,通过自定义配置参数,还可实现不同的排版风格和排版效果。希望此篇文章能为你带来价值,同时也推荐大家多多尝试使用这个实用的工具。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b6251ab1864dac6737d