npm 包 gatsby-remark-images 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

前言

在 Web 前端开发中,写博客是比较常见的事情。博客中通常会插入一些图片来展示内容,但是,将大量的图片直接放在文章中会使得博客加载速度变得很慢。为了优化网页加载速度,我们可以使用 gatsby-remark-images 这个 npm 包来实现对图片的优化。

什么是 Gatsby?

Gatsby 是一款基于 React 和 GraphQL 的前端应用框架。相对于传统的静态资源生成器,它支持一些更加高级的场景,比如动态数据获取,自适应图片处理,路由映射等。

对于博客网站来说,我们可以使用 Gatsby 来生成一个静态资源站点,使得访问者可以更快地获取需要的资源,同时也可以有效的减少服务器压力,提升网站的稳定性。

那么 Gatsby-Remark-Images 就是 Gatsby 中固有的一个 Remark 插件,用于为 Markdown 文档中的图片生成格式化的图片数据(比如尺寸大小、缩略图等信息),优化图片加载体验。

怎么使用 Gatsby-Remark-Images ?

下面我们依次介绍 Gatsby-Remark-Images 的安装、使用和配置。

安装

安装 Gatsby-Remark-Images 包:

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

使用

在 Gatsby 中使用 Remark 插件时,只要将 Remark 插件指定在 gatsby-transformer-remarkplugins 数组中即可生效。所以我们需要在在 Gatsby 的配置文件 gatsby-config.js 中加入以下配置:

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

我们需要将这个插件放在插件列表的第一个位置,这是因为在做图片优化时,它会先做图片处理,再将生成的图片数据替换 Markdown 文件中的图片链接。

最后,在你的 Markdown 文件中,你可以使用以下 Markdown 语法向文章中插入图片:

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

配置

可以传入 gatsby-remark-images 的配置参数嵌套在 gatsby-transformer-remark 插件的 parameters 里面,例如

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

可以有以下选项:

  • maxWidth 图片最大宽度(单位像素),默认情况下展示的图片为原尺寸,不会有固定宽度和高度,会影响页面主题。
  • linkImagesToOriginal 图片是否要生成 (链接到原图),参数默认值是 true 。
  • withWebp 添加(转化)Webp 格式的图片,默认值是 false。
  • tracedSVG 添加使用 SVG 方式的 placeholder 或占位符的占位符对象,您可以在任何唯一placeholder / bitmap处理阈值下使用其颜色 。
  • quality 图片的质量范围(0-100),默认值是 90。
  • backgroundColor 设置颜色表示生成的base64图片 background 。
  • showCaptions 控制是否显示图片的名字(来自alt属性),默认为 false。

示例代码

完整的使用示例代码如下:

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

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

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

总结

使用 Gatsby-Remark-Images 插件可以极大地提高网站图片的加载速度,同时也可以优化访客的使用体验。如果你正在构建自己的博客网站,可以尝试使用这个插件来为你的网站提供更好的图片加载体验。

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


猜你喜欢

  • npm 包 @moped/db-pg-schema 使用教程

    前言 在前端开发中,我们经常需要用到数据库,而其中 PostgreSQL 是一种广泛使用的关系型数据库。在使用 PostgreSQL 时,@moped/db-pg-schema 是一个不错的 npm ...

    4 年前
  • NPM 包 then-queue 使用教程

    前言 JavaScript 中回调函数和异步操作已经成为了最为常见的使用方式,npm 包 then-queue 则提供了一种更加简便的方法来进行异步操作的处理。 本篇文章将介绍如何使用 then-qu...

    4 年前
  • npm 包 then-rpc 使用教程

    npm 包 then-rpc 使用教程 引言 在前端开发中,客户端与服务器端的交互是非常重要的。为了达到这个目的,我们可以使用 then-rpc 这个 npm 包。

    4 年前
  • npm包 @moped/db-schema 使用教程

    随着前端技术不断发展,越来越多的前端工程师需要进行一些后端数据处理的工作。@moped/db-schema是一个npm包,提供了一些方便的方法来处理后端数据库的schema。

    4 年前
  • npm 包 grunt-terser 使用教程

    前言 在前端开发过程中,优化代码是非常重要的,可以极大地提高网站的性能和用户体验。而压缩 JavaScript 代码是其中非常重要的一项工作,可以减少文件体积,加快页面加载速度。

    4 年前
  • npm 包 html-minifier-terser 使用教程

    前言 在前端开发过程中,优化 HTML 代码是必不可少的一步。而 html-minifier-terser 是一款压缩和格式化 HTML 代码的工具,帮助我们缩减代码并提高网站性能。

    4 年前
  • npm 包 @moped/env 使用教程

    在日常的前端开发工作中,经常需要处理各种环境配置的问题。如果没有一个好用的工具来帮助我们管理这些环境变量,就可能会造成很多不必要的麻烦和错误。本文将介绍一个优秀的 npm 包 @moped/env,它...

    4 年前
  • npm 包 @moped/get-host-info 使用教程

    介绍 在前端开发中,有时候我们需要获取客户端的一些信息,例如客户端的 IP 地址、操作系统、浏览器等等。@moped/get-host-info 是一个可用于获取客户端信息的 npm 包。

    4 年前
  • npm 包 es6-for-of 使用教程

    在前端开发中,我们经常需要处理数组、对象等集合类型的数据。在 ES6(ECMAScript 2015) 之前,我们通常使用 for 循环、forEach 等方法来遍历集合类型数据,但这些方法存在一些缺...

    4 年前
  • npm 包 @moped/node-builtins 使用教程

    简介 @moped/node-builtins 是一个针对 Node.js 的 npm 包,它提供了一个裁剪版本的 Node.js 内置模块方法集,用于在前端项目中使用 Node.js 模块。

    4 年前
  • npm 包 @moped/babel-preset 使用教程

    简介 @moped/babel-preset 是一个基于 babel 的预设包,对 JavaScript 和 TypeScript 进行转换和编译。它能够使用在前端和后端技术栈中,帮助开发者在代码编写...

    4 年前
  • npm 包 @moped/enums 使用教程

    在前端开发中,经常会用到枚举(Enum)类型来表示一系列固定的值,通过枚举类型,可以更清晰地表达代码的意图和逻辑,提高代码的可读性和可维护性。但是,在 JavaScript 中本身并不支持枚举类型,因...

    4 年前
  • npm 包 @moped/polyfills 使用教程

    随着前端技术的不断发展,JavaScript 语言也逐渐成为了开发者必备的技能之一。而在 JavaScript 中,经常会出现一些跨浏览器兼容性的问题,这使得前端开发工作变得更加繁琐。

    4 年前
  • npm包 @moped/plugin-noop使用教程

    简介 @moped/plugin-noop是一个npm包,它允许您将一个空的插件(即不执行任何操作的插件)插入到moped插件架构中。这对于需要测试和调试时特别有用,也可以在开发过程中充当占位符。

    4 年前
  • npm包 @moped/rule-css 使用教程

    前言 在现代Web开发中,CSS的重要性不言而喻。不仅是为了让网页更美观,CSS还是网站根据不同设备进行响应式布局的关键。然而,具体的CSS规范并没有得到全面的统一。

    4 年前
  • npm 包 @moped/rule-file 使用教程

    介绍 最近在做前端项目开发的时候,经常需要对文件进行规则校验,因此在 npm 上找到了一个非常好用的包:@moped/rule-file。它可以帮助我们方便快速地进行文件规则校验。

    4 年前
  • npm 包 @moped/load-ts-config 使用教程

    简介 @moped/load-ts-config 是一个用来加载 TypeScript 配置的 npm 包,可以帮助前端工程师快速、简单地读取并使用 TypeScript 配置信息。

    4 年前
  • npm 包 @moped/rule-ts 使用教程

    简介 在前端开发中,TypeScript 是一个广泛使用的编程语言。而在使用 TypeScript 进行开发时,如何保证代码的规范性和可读性是非常重要的。@moped/rule-ts 就是一个用于规范...

    4 年前
  • npm 包 @moped/webpack-config-base 使用教程

    npm 包 @moped/webpack-config-base 使用教程 前言 在前端开发中,Webpack 是一款非常流行的模块打包工具。相信大部分前端开发人员都有使用过 Webpack 的经验。

    4 年前
  • npm 包 @moped/plugin-env 使用教程

    在前端开发中,我们经常需要获取当前环境的一些配置信息,如:区分开发环境和生产环境、获取 API 请求的基础路径等等。而 @moped/plugin-env 这个 npm 包就是帮助我们管理环境的工具。

    4 年前

相关推荐

    暂无文章