npm 包 gulp-inlinerjs 使用教程

前言

对于前端工程师来说,优化资源加载是一项很重要的工作。在 Web 开发中,我们通常会遇到如图片未压缩、未使用雪碧图、CSS/JS 资源未压缩等常见问题,而这些都会影响网站的性能和加载速度。因此,在此提供一个 NPM 包 —— gulp-inlinerjs,来优化前端资源加载,进而提高网站性能和体验。

什么是 gulp-inlinerjs?

gulp-inlinerjs 是一个使用 InlinerJS 库内联 HTML/CSS 与 JS 的 gulp 插件。通俗来说,gulp-inlinerjs 可以将 HTML/CSS 与 JS 内联进主 HTML 文件中,减少网页资源请求次数,从而提高加载速度。

如何安装 gulp-inlinerjs?

在使用 gulp-inlinerjs 之前,需要安装 gulp 和 gulp-inlinerjs:

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

gulp-inlinerjs 的使用教程

1. 基本使用

在 gulpfile.js 中引入 gulp 和 gulp-inlinerjs:

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

创建任务 task:

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

执行任务:

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

经过内联操作,index.html 文件已转换为下面的格式,并保存到 ./dist/ 目录下:

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

在 HTML 文件中,原本引入的 CSS 和 JS 代码被内联进 HTML 中,而在浏览器中打开该文件时,仅会发送一次请求,从而减少了加载时间。

2. 可选项

gulp-inlinerjsoptions 中,支持以下几个可选项:

css (默认值:true)

将所有在 HTML 或标注中引用的 CSS 都内联到 HTML 头部中的 <style> 标签里。

js (默认值:true)

将 JavaScript 内容替换任何用 <script> 标签引用的 JavaScript 文件(包括内联的)。

prescript (默认使用空字符串)

会在 任意 执行的 JavaScript 之前放置赋值给 window.__inlinerJs 的代码,例如:

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

postscript (默认使用空字符串)

会在 任意 执行的 JavaScript 之后放置的代码,例如:

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

3. 模板使用

除了内置的 opts,也支持自定义模板并使用。默认模板在 ./templates/default/index.html 下定义,可以在此修改。

模板中已包含的模板标记如下表:

标记 描述
<% css %> 将 CSS 条目内联为 HTML 中头部的 <style> 标签
<% js %> 将 JavaScript 内容替换任何用 <script> 标签引用的 JavaScript 文件(包括内联的)
<% base64DataUrl %> 内联所有指定的 Base64 图片
<% META title="Your Title Here" %> 在头部添加注释,例如:<title>Your Title Here</title>

将自定义模板设置从选项传递,例如:

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

通过传递 templateUrl 选项来更改缺省模板。

注意事项

  • 若在 HTML 标签中使用了 src 属性,且想使其内联,可以使用以下方法:
---- ----------------------------- ------------------
-------------------- -------- -- -
    ------ ----------
      -------------
      ------------
    --
    ---------------
        ---- ----- -- -- ---
        --- ----- -- -- --
        ------ ----- -- ----
        ------- ---- -- ----
    ---
    ----------------------------
---
  • 在使用 gulp-svgstore 插件时,需要使用 gulp-cheerio 重新定义生成的 html 文件中的 ID 标签,外部样式引用时会用到。

结语

通过 gulp-inlinerjs 这个 npm 包,让内联操作变得简单而快捷,不仅可用于实现图片或矢量图标的优化内联,在某些特定场景下,也可以使用插件将所需的 JS、CSS、HTML 等直接内联到页面底部,大大缩短首次页面加载时间和响应时间,提升用户体验。

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


猜你喜欢

  • npm 包 coyote 使用教程

    什么是 coyote? coyote 是一款基于 TypeScript 实现的表达式解析引擎,其具有高度的性能、可扩展性和灵活性。它可以用于编写编译器、静态类型检查器、ORM 等等。

    5 年前
  • npm 包 isuri 使用教程

    简介 isuri 是一个 npm 包,可以用于判断一个字符串是否为合法的 URL。在前端开发中,判断 URL 是否合法是一个经常会用到的功能。isuri 可以帮助我们快速、准确地判断一个字符串是否为 ...

    5 年前
  • npm 包 coc-omnisharp 使用教程

    #npm 包 coc-omnisharp 使用教程 ##前言 如果你是一个前端开发者,你肯定会遇到需要写一些 C# 代码的情况。在这种情况下,你需要一个工具来编写和调试你的代码。

    5 年前
  • npm 包 coc-utils 使用教程

    简介 coc-utils 是一个非常实用的 npm 包,它提供了一些编写前端代码的工具函数,可以帮助开发者提高开发效率。它包含了诸如补全函数、判断函数等工具函数,可用于提高代码的质量和可读性。

    5 年前
  • npm 包 coc-fsharp 使用教程

    npm 包 coc-fsharp 是一款用于 Visual Studio Code 中的一个 F# 语言开发的插件,它支持语法高亮,自动补全和智能重构等功能。在使用过程中,coc-fsharp 可为开...

    5 年前
  • npm 包 stylelint-lsp 使用教程

    在前端开发中,我们经常需要使用到 stylelint 进行样式的检查。有时候,我们需要对代码中的样式进行修正,这时候我们就可以借助 npm 包 stylelint-lsp 来实现自动修正样式问题。

    5 年前
  • npm 包 coc-stylelintplus 使用教程

    简介 在前端开发过程中,为了保证代码的质量和风格的一致性,我们通常会使用代码检查工具来进行静态分析。而 Stylelint 是一个非常强大的 CSS 代码检查工具,可以检测到许多与风格有关的问题,并提...

    5 年前
  • npm 包 coc-jira-complete 使用教程

    前言 在前端开发中,我们常常需要使用 JIRA 进行项目管理,但是在编辑 JIRA Issue Key 的时候会遇到繁琐的问题,如拼写错误、格式不一致等等。好在有一个叫做 coc-jira-compl...

    5 年前
  • npm 包 coc.nvim 使用教程

    简介 coc.nvim 是一款面向 Neovim 的轻量级的语言服务器客户端。它可以通过 npm 包安装,在前端开发中提供语法补全、代码跳转、重构、linting 等功能,提高生产效率。

    5 年前
  • npm 包 coc-angular 使用教程

    介绍 coc-angular 是一个 Coc 插件,可以帮助我们在 Vim 或 Neovim 中更加方便高效地开发 Angular 程序。通过这个插件,我们可以享受到各种完善的功能,比如代码补全、语法...

    5 年前
  • npm 包 vue-i18n-helper 使用教程

    简介 vue-i18n-helper 是一个方便 Vue 项目国际化(i18n)的 npm 包,它可以帮助我们快速、简单地为项目添加多语言支持。它的主要优点是: 简单易用:只需要传入一个语言包对象,...

    5 年前
  • npm 包 vsce 使用教程

    随着前端技术的进步,开源社区和 npm 生态系统变得越来越重要。作为一名前端工程师,你可能经常使用 GitHub 和 npm 以及从中收集许多实用、有趣或者优秀的开源工具和库。

    5 年前
  • npm 包 style-vars-panel 使用教程

    前言 在前端开发中,我们通常需要通过 CSS 来控制网页的样式。然而,在大型项目中,CSS 文件可能会有数千行代码,难以管理和维护。此时,我们可能需要使用预处理器来管理 CSS。

    5 年前
  • npm 包 nearest-color 使用教程

    介绍 在前端开发中,经常需要使用到颜色相关的操作,如计算两个颜色的差值、找到最接近的颜色等等。在这个时候,我们可以使用 npm 包 nearest-color 来解决这些问题。

    5 年前
  • npm 包 iobroker.alexa2 使用教程

    前言 iobroker 是一个针对智能家居的平台,它提供了丰富的插件来支持多种智能设备。其中 iobroker.alexa2 就是一个支持亚马逊 Alexa 的插件,可以帮助你在 iobroker 平...

    5 年前
  • npm 包 virtual-device-sdk 使用教程

    前言 当我们在开发前端应用或者网站的时候,有时我们需要测试一些功能或者页面在各种设备上的表现,这个时候就可以使用虚拟设备来模拟各种不同的设备。而 virtual-device-sdk 就是一个可以帮助...

    5 年前
  • npm 包 serverless-bespoken 使用教程

    什么是 serverless-bespoken serverless-bespoken 是一个基于 AWS Lambda 和 API Gateway 的开源工具包,是用于构建无服务器的 Amazon ...

    5 年前
  • npm 包 jovo-cli 使用教程

    什么是 jovo-cli? jovo-cli 是一个用于构建语音应用程序的命令行工具。它可以让你快速启动、测试和部署 Alexa 和 Google Assistant 的语音应用程序,同时还支持多个语...

    5 年前
  • npm 包 serverless-plugin-bespoken 使用教程

    简介 在现代的开发中,serverless 架构已经成为了一个趋势,它可以使我们更专注于业务逻辑的实现,而不是繁琐的服务器和运维管理。而 serverless-plugin-bespoken 是一款能...

    5 年前
  • npm 包 bespoken-tools 使用教程

    简介 Bespoken-tools 是一个基于 Node.js 的命令行工具,它可以帮助我们进行 Alexa 技能的本地开发、测试以及调试。通过在本地运行 Alexa 技能,我们可以提高开发效率、减少...

    5 年前

相关推荐

    暂无文章