npm 包 marked-renderer-pdf 使用教程

简介

marked-renderer-pdf 是一个基于 marked 的 npm 包,可以将 markdown 文件转化为 PDF 文件,支持中文排版和不同的排版风格。

安装

在终端中使用以下命令安装:

--- ------- ------------------- ------

使用方法

库引入

首先,在项目文件中引入 marked-renderer-pdf 库:

----- ----------------- - -------------------------------

初始化

然后,需要初始化 MarkedRendererPdf 对象,以配置需要的参数。初始化方法如下:

----- -------------- - --- ---------------------------

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 是可选参数,包括 titlesubtitle,分别表示标题和副标题。

----- ------- - -
    ------ ---------
    --------- ----------
--

------------------------ -------- --------
    -------- -- -
        ---------------- ----------
    --
    ------------ -- -
        -------------------
    ---

示例代码

----- ----------------- - -------------------------------

----- -------------- - --- -------------------
    ---------- -----
    ------ -----
    ------ ----
---

----- ------- - -
    ------ ---------
    --------- ----------
--

------------------------ -------- --------
    -------- -- -
        ---------------- ----------
    --
    ------------ -- -
        -------------------
    ---

总结

marked-renderer-pdf 是一个非常实用的 npm 包,可以帮助前端开发人员将 markdown 文件快速转化为 PDF 文件。此外,通过自定义配置参数,还可实现不同的排版风格和排版效果。希望此篇文章能为你带来价值,同时也推荐大家多多尝试使用这个实用的工具。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066b6251ab1864dac6737d


猜你喜欢

  • npm 包 catch.min.js 使用教程

    介绍 catch.min.js 是一个基于浏览器端的 JavaScript 库,可帮助前端开发人员处理错误信息的展示和处理。该库提供了许多实用的功能,包括错误提示,错误追踪和错误日志管理等等。

    3 年前
  • npm 包 core.min.js 使用教程

    前言 随着前端技术的不断发展,各种工具和框架层出不穷。其中,npm 是一个非常实用的包管理工具,无论是在开发还是部署过程中都起到了至关重要的作用。在 npm 上,有很多方便开发者的包和插件,其中 co...

    3 年前
  • npm 包 boss.min.js 使用教程

    前端开发中,使用各种工具和库是必不可少的,其中,npm 包的使用已经成为前端开发的主领域之一。而在 npm 包中,boss.min.js 是一个非常实用的工具,本文将详细介绍如何使用 boss.min...

    3 年前
  • npm 包 @instancejs/react-forms 使用教程

    在前端开发中,表单组件是最常用的组件之一。而 @instancejs/react-forms 是一个高度可定制且易于使用的 React 表单元素库,它提供了一系列的表单组件,包括输入框、单选框、复选框...

    3 年前
  • npm 包 @ibrokethat/deep-seal 使用教程

    介绍 @ibrokethat/deep-seal 是一个用于将对象中的所有属性都封闭成不可扩展、不可配置和不可写的 npm 包。这样可以确保对象的属性不会被修改、删除或者添加,从而保护 JavaScr...

    3 年前
  • npm 包 collaborator.min.js 使用教程

    简介 npm 是一个 Node.js 包管理器,是全球最大的软件包注册表,其中提供了数量庞大的 JavaScript 包供开发者使用。而 collaborator.min.js 就是其中一个非常实用的...

    3 年前
  • npm 包 buffer.min.js 使用教程

    npm 包 buffer.min.js 使用教程 在前端开发过程中,我们有时需要在不同的数据类型之间进行转换,比如将字符串转换成数组或者二进制流。这时,npm 包 buffer.min.js 就可以派...

    3 年前
  • npm 包 @icetee/time-ago 使用教程

    介绍 在前端开发过程中,时间是一个非常重要的概念。而如何处理时间也是一个比较复杂的问题。在实际开发中,我们经常需要将一些时间戳或者日期格式,转换成容易理解的“几分钟前”、“一小时前”、“昨天”、“上个...

    3 年前
  • npm 包 @ibrokethat/clone 使用教程

    前言 在前端项目开发中,经常会使用到复制数据对象的需求,而常规的复制对象方式可能会因为浅拷贝而造成数据出错等问题。而在这种场景下, 使用 npm 包@ibrokethat/clone 可以帮助你避免这...

    3 年前
  • npm 包 code.min.js 使用教程

    在前端开发中,我们经常需要使用到代码高亮的功能。而在实现代码高亮时,我们可以使用一些成熟稳定的库。其中,code.min.js 就是一款非常实用的 npm 包,它能够快速而准确地对代码进行高亮,并可自...

    3 年前
  • npm 包 @ibrokethat/auto-index 使用教程

    简介 随着前端项目越来越复杂,我们通常需要在项目中引入大量的模块和组件。在这个过程中,为了方便管理和使用,我们常常需要对引入的文件进行统一的管理和自动化。 @ibrokethat/auto-index...

    3 年前
  • npm 包 categories.min.js 使用教程

    简介 categories.min.js 是一个基于 JavaScript 的轻量级工具,可用于创建带有类别的视觉效果。它可以轻松地在您的前端项目中集成,并使您可以快速创建具有类别的网站、应用程序和其...

    3 年前
  • npm 包 @ibrokethat/supermyx 使用教程

    介绍 @ibrokethat/supermyx 是一个用于前端开发的 npm 包,它提供了一系列工具和方法,用于管理和处理各种类型的数据。 这个包包含了一些常用的方法,例如深度合并对象,合并数组,构建...

    3 年前
  • npm 包 box.min.js 使用教程

    在前端开发中,我们经常会用到各种 JavaScript 库和框架。而在这些库和框架中,很多都是通过 npm 包管理工具来维护和发布的。在这篇文章中,我们将介绍一个非常实用的 npm 包——box.mi...

    3 年前
  • npm 包 bug.min.js 使用教程

    前言 在前端开发中,我们经常会使用各种 npm 包来提高开发效率。但有时,我们会遇到一些难以解决的 bug,这时我们需要通过一些工具来帮助我们更快地解决问题。今天我们来介绍一个可以帮助我们更好地处理 ...

    3 年前
  • npm 包 build.min.js 使用教程

    前端开发中,我们经常需要使用一些优秀的第三方库或者框架来辅助项目开发。这些第三方库或者框架通常都是以 npm 包的形式发布,因此,我们需要了解如何使用 npm 包来实现技术功能。

    3 年前
  • npm 包 @intactile/node-api-client 使用教程

    简介 @intactile/node-api-client 是一个使用 Node.js 编写的 API 客户端。它提供了一种轻松的方式来与各种 Web API 进行交互。

    3 年前
  • npm包 @intactile/express-domain-middleware使用教程

    简介 @intactile/express-domain-middleware 是一个基于domain模块实现的 Express 中间件。该中间件可以用来捕获异步代码中的错误,并将它们与请求上下文关联...

    3 年前
  • npm 包 @intabulas/nodal-middleware-ratelimit 使用教程

    在现代 Web 应用程序的开发中,限制 API 请求速率是常见的需求。@intabulas/nodal-middleware-ratelimit 是一个帮助 Node.js 开发者限制 API 请求速...

    3 年前
  • npm 包 @inteach/react-native-scroll-indicator 使用教程

    前言 React Native 是一种基于 JavaScript 的开源框架,用于开发手机应用程序。对于前端工程师来说,React Native 是一门强大的技术,可以通过它快速地开发原生应用程序。

    3 年前

相关推荐

    暂无文章