npm 包 inky-cli2 使用教程

什么是 inky-cli2?

inky-cli2 是一个基于 Node.js 的命令行工具,用于将 HTML 和 CSS 转换为可嵌入电子邮件的邮件模板。

该工具提供了丰富的模板语法和布局选项,以方便快速地构建出适用于多种邮件客户端的邮件模板。并且支持图片压缩、Base64 编码等等特性,以优化邮件加载速度。

如何安装?

在终端中执行以下命令安装 inky-cli2:

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

如何使用?

  1. 在终端中进入到项目的根目录,并创建一个空目录,用于存放编译后的邮件模板。

  2. 创建一个 HTML 文件,包含所需的模板和布局。

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

    上述示例使用了一个简单的模板,包含一个表格和一段文本,其中 {{name}} 为一个占位符,将在编译时被替换成真实的文字内容。

  3. 在终端中执行以下命令,使用 inky-cli2 进行编译:

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

    该命令的含义为:将 input.html 编译为邮件模板,并输出到 output 目录下。同时,指定了一个包含占位符替换数据的 JSON 文件 data.json,和一个存放局部模板文件的目录 partials。

  4. 在编译完成后,输出目录将包含一个编译后的邮件模板,如下所示:

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

    可以看到,占位符 {{name}} 被替换为了真实的文字内容,CSS 样式也被编译后的样式替换掉了。

inky-cli2 的应用场景

inky-cli2 可以广泛应用于电子邮件营销、邮件通知等领域。它可以帮助开发者快速构建复杂的邮件模板,而无需手动进行复杂的 HTML 和 CSS 编写。

常见的应用场景包括:

  • 邮件认证:向用户发送确认邮件,以验证其身份。
  • 提醒通知:发送邮件提醒用户某项行动的状态变更。
  • 营销邮件:向用户发送相关产品或服务的信息。
  • 调查问卷:向用户发送调查问卷等内容。

示例代码

以下是一个简单的示例,使用 inky-cli2 编译一封带有图片的邮件模板。

HTML 模板:

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

数据文件 data.json:

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

局部模板 partials/header.html:

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

命令行编译指令:

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

编译后的邮件模板:

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

可以看到,邮件模板中的图片已被压缩和 Base64 编码,提高了邮件的加载速度和可靠性。同时,也嵌入了一个附带的图片,以避免在邮件客户端中丢失。

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


猜你喜欢

  • npm 包 simple-table-builder 使用教程

    简介:simple-table-builder 是一个使用 Node.js 编写的简单易用的 npm 包,用于生成 HTML 表格。它不需要任何依赖,可以和任何 HTML 模板引擎配合使用,例如 EJ...

    2 年前
  • npm 包 bcrypt-cached 使用教程

    在现代 web 应用中,用户密码的安全性非常关键。bcrypt-cached 是一个用于 Node.js 的密码加密库,可以帮助开发者实现安全的用户身份验证。本文将介绍如何使用 bcrypt-cach...

    2 年前
  • NPM 包 Codux 的使用教程

    Codux 是一个专门为 React 应用设计的 Redux 状态管理器。它使您可以轻松地管理应用程序的状态,并减少了 Redux 的模板代码量。本文旨在介绍 Codux 的基本概念及其使用方法。

    2 年前
  • npm 包 initgraph 使用教程

    在前端开发过程中,我们经常需要使用图表来展示数据,而且为了提高开发效率,我们可以使用一些成熟的图表库。但是如果搜索一下 npm 上的图表库,会发现有很多种选择,让人眼花缭乱。

    2 年前
  • npm 包 messenger-pattern 使用教程

    什么是 messenger-pattern? messenger-pattern 是一种用于前端组件间通信的设计模式。在一个大型的前端项目中,通常会出现很多个组件,它们之间需要进行通信交互。

    2 年前
  • npm 包 debug-barangular 使用教程

    简介 Debug-barangular 是一个基于 Angular 的调试工具,它提供了一个简单易用的界面,可以帮助开发者更方便地调试应用程序。该工具通过使用 ng-debug-bar 模块来实现,该...

    2 年前
  • npm 包 blessed-circle 使用教程

    简介 blessed-circle 是一个受欢迎的 npm 包,它用于在终端上创建漂亮的圆形。它是 blessed 模块的一部分,以同样的方式工作。在这篇文章里,我们将为大家提供一个使用教程,帮助您学...

    2 年前
  • npm 包 hubot-graylog-adapter 使用教程

    前言 如果你正在开发机器人系统,而且使用的是 hubot 框架,那么 hubot-graylog-adapter 十分值得一试。使用 hubot-graylog-adapter,你可以将机器人的日志发...

    2 年前
  • npm 包 gitrelease 使用教程

    简介 在前端开发中,我们常常需要发布页面或组件等项目。其中,常常需要更新版本号并推送到 Git 仓库中。而 GitRelease 可以帮助我们自动执行这一过程。本文将详细介绍 npm 包 GitRel...

    2 年前
  • npm 包 scroll-background 使用教程

    随着前端技术的飞速发展,越来越多的 npm 包被开发出来,方便前端工程师完成各种复杂的设计任务。其中,scroll-background 就是一种非常有用的 npm 包,可以帮助你实现众多的网站背景动...

    2 年前
  • npm 包 @arpit09/angular-vanilla 使用教程

    前言 @arpit09/angular-vanilla 是一个用于 Angular 应用的原生 JavaScript 库,提供了一些常见的 DOM 操作和工具函数,例如事件绑定、选择器、动画等等。

    2 年前
  • npm 包 @barbuza/jszip 使用教程

    介绍 随着前端项目越来越复杂,我们需要将数据进行压缩、解压缩处理,以减少网络带宽占用和提高传输速度。在这种情况下,使用 @barbuza/jszip 可以帮助我们在前端进行数据的压缩和解压缩处理。

    2 年前
  • npm 包 @bijujoseph/ng2-nvd3 使用教程

    前言 @bijujoseph/ng2-nvd3 是一个基于 D3.js 的图表库,用于 Angular 2 及以上版本的前端项目中。 该库提供了众多常见图表的组件,如折线图、柱状图、饼图等,且定制化程...

    2 年前
  • npm 包 listen-events 使用教程

    什么是 npm 包 listen-events? npm 包 listen-events 是一个安装在 Node.js 环境中的事件监听库,它的作用是为你的应用程序提供一个灵活可靠的事件监听和触发的机...

    2 年前
  • npm 包 kilos_to_libras 使用教程

    在前端开发中,我们经常需要进行单位转换,例如将公斤转换为磅。npm 包 kilos_to_libras 就是一个能够帮助我们在 JavaScript 中将公斤转换为磅的工具库。

    2 年前
  • npm 包 radium-browser-state-plugin 使用教程

    前言 在前端开发中,我们经常需要对元素的状态进行动态改变,比如改变颜色、位置、大小等等,而且这些改变往往需要在用户交互的时候进行,也就是说要通过 JavaScript 来实现。

    2 年前
  • npm 包 @nju33/rollup-preset 使用教程

    前言 对于前端开发者来说,构建和打包代码是非常重要的一环,从而优化前端性能、提高开发效率。而 rollup.js 是一个优秀的 JavaScript 模块打包器,它可以将指定入口文件中用到的模块打包成...

    2 年前
  • npm包@maksimr/karma-electron-launcher使用教程

    前言 随着前端技术的快速发展,前端自动化测试越来越受到大家的关注。在这个领域中,Karma是一个非常流行的测试运行器,它支持各种测试框架,包括Jasmine、Mocha、QUnit等等。

    2 年前
  • npm包eslint-config-auz使用教程

    在前端开发中,代码质量是非常重要的。而遵循一定的代码规范可以提高代码的可读性、可维护性和可扩展性。而eslint作为目前流行的JavaScript语法检查工具,可以规范代码风格、发现潜在问题,为我们提...

    2 年前
  • npm 包 json-parser-plus 使用教程

    简介 在前端开发中,经常需要解析 JSON 数据。而解析 JSON 数据的工具有很多,其中 json-parser-plus 是一款非常好用的 npm 包。该包不仅可以解析 JSON 数据,还可以对 ...

    2 年前

相关推荐

    暂无文章