npm 包 marked-imgix 使用教程

什么是 marked-imgix

marked-imgix 是一款基于 marked 和 imgix-js 的 npm 图片处理包。它可以通过扩展 marked 语法,让你添加 imgix-js 的图片处理功能,使得在显示图片时能够直接进行缩放、旋转、裁剪等处理,并且支持响应式布局。

如何安装

你可以通过 npm 安装 marked-imgix,运行以下命令:

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

如何使用

第一步:引入

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

第二步:设置配置项

你可以设置如下选项:

  • imgixHost:你的 imgix 域名;
  • imgixParams:默认的 imgix 处理参数;
  • autoMarkedOptions:默认的 marked 配置参数;
  • skipImgix:不处理 imgix 图片的 className 列表;
  • imgixMarkdownAttribute:设置 imgix 的 markdown 属性。

示例代码:

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

第三步:渲染 markdown 字符串

实例化 marked 并将渲染器传入。同时,你还应该把渲染后的 html 插入到你需要的元素中。

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

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

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

第四步:扩展 marked-imgix

现在,你可以在 markdown 文本中使用 marked-imgix 的语法了。比如:

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

这个语法将返回一个处理后的 imgix 图片。

你还可以使用 imgix-js 的其他功能。通过 imgixParams 中设置的默认参数,在不设置参数的情况下,这些参数将自动应用于所有的 imgix 图片。

示例代码

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

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

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

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

结语

marked-imgix 是一款简单易用的图片处理模块,它通过对 marked 进行扩展,可以为开发人员提供更多的图片处理选项,帮助他们快速完成项目开发。希望这篇文章对你有所启发,如果你有任何问题、建议或意见,请在评论区留言!

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


猜你喜欢

  • npm 包 javascript-easy-object 使用教程

    javascript-easy-object 是一款简洁易用的 JavaScript 库,它可以帮助开发者更加方便地管理和操作 JavaScript 对象。这个 npm 包可以让你以对象的方式来访问任...

    3 年前
  • npm 包 oock 使用教程

    介绍 oock 是一个前端工具库,提供了很多实用的工具函数和组件,让前端开发更加便捷。它是一个基于 Node.js 的 npm 包,可以在项目中直接引用并使用。 在本文中,我们将详细讲解如何使用 oo...

    3 年前
  • npm 包 Lori-bites 使用教程

    Lori-bites 是一个用于前端开发的 npm 包,它提供了一些常用的组件和工具函数,可以使开发者更加方便地编写前端应用。在本文中,我们将介绍 Lori-bites 的使用方法,包括如何安装、如何...

    3 年前
  • npm 包 md-datetimepicker 使用教程

    在前端开发中,日期时间选择框是比较基础的组件之一。而 md-datetimepicker 是一个简单、易用的日期时间选择器,可以轻松渲染日期选择、时间选择和日期时间选择。

    3 年前
  • npm 包 preact-dnd 使用教程

    简介 preact-dnd 是一个用于实现拖拽效果的npm包,它是基于React的DnD库react-dnd的轻量级版本。它能够方便地实现各种拖放功能。 安装 您可以通过npm安装preact-dnd...

    3 年前
  • npm包mongodates的使用教程

    概述 mongodates是一个npm包,可用于轻松处理日期以及与MongoDB数据库的日期存储交互。mongodates在Node.js应用程序中的使用非常灵活,因为它允许我们轻松地将日期格式化成所...

    3 年前
  • npm 包 ayak 使用教程

    简介 在前端开发中,我们经常会使用到各式各样的第三方库,而 npm 包则是我们最常使用的一种。其中,ayak 是一款基于 Vue 的组件库,提供了多种常见的 UI 组件和工具函数,可协助我们快速搭建前...

    3 年前
  • npm 包 ember-m-image 使用教程

    在现代 Web 开发中,图片的处理和展示一直是一个不可避免的话题。为了解决这个问题,我们可以利用基于 Ember.js 开发的 npm 包 ember-m-image 实现对图片的高效、可定制化的处理...

    3 年前
  • npm 包 rpgatsumaru-api 使用教程

    简介 rpgatsumaru-api是在rpgmaker mv端使用的一款API,供开发者在线获取游戏内数据。它可以帮助开发者更加方便地处理游戏数据,提高开发效率。

    3 年前
  • NPM 包 grunt-sasson 使用教程

    在前端开发中,Sass 是一种优秀的预处理器,它可以简化 CSS 书写、增加代码可读性、提高开发效率等等。而 grunt-sasson 包则是一种基于 Grunt 的 Sass 编译工具,它可以将 S...

    3 年前
  • npm包 serverless-gulp 使用教程

    前言 对于前端开发者来说,构建和部署项目是一个繁琐的过程,但是使用工具能够大大简化这个过程。在这里,我们将介绍一个npm包 serverless-gulp,这个包可以帮助我们在服务器上运行Gulp任务...

    3 年前
  • npm 包 isuse-ui 使用教程

    前言 isuse-ui 是一个基于 Vue.js 开发的前端 UI 组件库,其中包括了大量常用的 UI 组件,如按钮、输入框、表格等。通过使用 isuse-ui,可以帮助开发者节省时间和精力,快速搭建...

    3 年前
  • npm 包 object-helpers 使用教程

    在前端开发中,我们经常需要对 JavaScript 中的对象进行操作和处理。而为了简化这个过程,我们可以使用一些好用的工具包。其中,npm 包 object-helpers 就是一个非常不错的选择。

    3 年前
  • npm包 ntnx-request-handler的使用教程

    简介 ntnx-request-handler是一个Node.js的npm包,用于处理HTTP请求。它提供了一个方便的API让你可以轻松地处理请求,并在需要时发送回复。

    3 年前
  • npm 包 @actra-development-oss/material-design-icons 使用教程

    在很多前端开发的项目中,图标的运用是非常普遍的,而 Material Design Icons 是一个非常受欢迎的图标库,包含了超过 4,000 个精美的图标,可在任何 Web 或者移动应用中使用。

    3 年前
  • npm 包 tfsjson2csv 使用教程

    介绍 tfsjson2csv 是一个 npm 包,用于将 TFS (Team Foundation Server) 上的工作项数据转换为 CSV 格式,方便实现数据的导出和处理。

    3 年前
  • npm 包 holidays-nordic 使用教程

    在本文中,我们将了解npm包 holidays-nordic的使用方法。这个 npm 包 可以用来查看北欧地区的节假日。它提供了一些有用的函数,可以返回节假日的具体信息。

    3 年前
  • npm 包 convert-color 使用教程

    前言 在前端开发中,我们经常遇到需要将颜色转换成不同格式的情况。而 convert-color 就是一个用于颜色转换的 npm 包,它支持多种格式的颜色转换。 在本文中,我们将学习如何使用 conve...

    3 年前
  • npm 包 semver-level-harmony 使用教程

    在前端开发中,我们经常会用到版本号的概念。而 semver-level-harmony 是一个 npm 包,可以帮助我们更好地管理和对比版本号。本文将介绍 semver-level-harmony 的...

    3 年前
  • npm 包 seven-segment-display 使用教程

    在前端开发中,有时候需要显示数字或字母,且需要使用七段显示效果。这时候,npm 包 seven-segment-display 就是一个非常方便实用的工具。 seven-segment-display...

    3 年前

相关推荐

    暂无文章