npm 包 bespoke-highlightjs 使用教程

简介

当我们在设计网页时,经常会需要在页面中呈现代码片段或者代码区域。bespoke-highlightjs 是一个帮助我们通过高亮显示呈现代码的 npm 包。它基于 highlight.js,允许使用多个风格和语言对代码进行高亮显示和呈现。

本文将提供详细的使用教程,让你快速掌握该 npm 包的使用方法,并让你了解其深入内部的工作机理。

安装

使用 npm 包管理工具安装 bespoke-highlightjs。

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

使用

引入

在 HTML 文件中引入 highlight.js 和 bespoke-highlightjs 的 CSS 文件和 JS 文件。

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

使用

bespoke-highlightjs 需要结合 bespoke.js,使用它来高亮呈现我们想要的代码区域。

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

在 bespoke.js 中使用 bespoke-highlightjs 的代码非常简单。首先我们需要定义一个 highlight 对象,然后将其传入 bespoke.js。highlight 对象会从 HTML 文件中获取所有代码块,并对其进行高亮处理。

配置

下一步,我们可以配置 bespoke-highlightjs 的属性以满足我们的需求。

在 HTML 文件中,我们可以像下面这样配置 bespoke-highlightjs:

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

当我们使用 bespoke.plugins.highlight() 时,bespoke-highlightjs 会自动扫描 HTML 文件中的 .bespoke-highlightjs 类型对象并将其从 pre 片段中提取出来,对其中的代码进行高亮处理。

在 JavaScript 文件中,我们可以这样配置 bespoke-highlightjs:

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

我们可以根据自己的需要来配置 stylelanguage 属性。style 属性会在多个 highlight.js 风格中选择一个风格来高亮显示我们的代码,language 属性则选择要高亮显示的代码的语言种类。

我们也可以使用以下方法来管控配置:

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

示例

有关如何使用 bespoke-highlightjs 的示例代码如下:

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

结束语

bespoke-highlightjs 是一个非常优秀的 npm 包,让我们不需要手动调整代码高亮显示的样式,而将其作为插件使用会让代码显示更加清晰,增强代码的可读性和可维护性。希望能更好地运用这个插件。

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


猜你喜欢

  • npm 包@hokid/generator-userfy 使用教程

    介绍 在现代前端开发中,构建工具的使用已经成为了必要的技能。而搭建工程化的项目结构也是其中的重要部分。@hokid/generator-userfy 正是为了方便前端开发者快速搭建项目结构而生的一个 ...

    3 年前
  • npm 包 amqplib-rabbitmq-pub-sub 使用教程

    在前端开发中,如何处理消息推送是一个非常重要的问题,特别是当你需要处理大量的数据或实时数据时。一种常见的方法是使用 RabbitMQ 来实现发布-订阅模式。在本文中,我们将介绍如何使用 amqplib...

    3 年前
  • npm 包 angular-validate-br 使用教程

    在前端开发中,表单验证是一个重要的环节。为了方便开发者进行表单验证,有很多前端框架提供了自己的表单验证模块,但有些情况下,我们需要自己进行表单验证。 本文将介绍一个 npm 包:angular-val...

    3 年前
  • npm 包 array-emojify 使用教程

    如果你在开发过程中需要将不同类型的数据进行分组或者排序,那么你一定需要用到数组(array)。而在 JavaScript 中,数组是非常常见且重要的数据类型之一。但是,如何将数组中的数据进行高效的维护...

    3 年前
  • npm包 obj-emojify使用教程

    简介 obj-emojify是一个可以将字符串中的emoji表情转换为emojione对象的npm包。它是基于emojione库实现的,并且可以在浏览器和node.js等环境下使用。

    3 年前
  • 前端必备技能之 npm 包 @lvchengbin/sleep 使用教程

    前端开发中,我们经常会遇到需要暂停一段时间的场景,比如等待某些资源加载完成后再执行下一步操作,或者为了更好的用户体验,需要动画效果中间暂停一段时间。这时候,就需要用到 @lvchengbin/slee...

    3 年前
  • npm 包 boujee 使用教程

    在前端开发过程中,我们经常需要使用各种库和框架来提高效率和减少代码量。npm (Node Package Manager) 是一个非常流行的 JavaScript 包管理器,它能够方便地安装和管理各种...

    3 年前
  • npm 包 emit-all-plugin 使用教程

    在前端开发中,我们经常会遇到需要监听特定事件并触发回调函数的情况。而在某些情况下,我们需要监听的事件可能比较多,如果每个事件都写一个监听函数,代码量和维护成本都会变得很高。

    3 年前
  • npm 包 remote-keyboard 使用教程

    前言 随着云计算、跨平台和移动化的发展,我们越来越需要一个可靠且方便的远程终端控制工具。而 remote-keyboard 就是这样一个基于 Node.js 的 npm 包,能够让你轻松控制远程终端。

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

    简介 doggo-api-wrapper 是一个基于 Node.js 的 npm 包,用于访问 Dog CEO API,该 API 提供了各种狗的图片,品种等信息。

    3 年前
  • npm 包 nodejs-portfolio 使用教程

    在前端开发中,我们经常需要将自己的作品以一种专业的方式展示给大家,而 nodejs-portfolio 就是一个非常好用的 npm 包,它可以帮助我们快速创建一个个人作品展示页面。

    3 年前
  • npm 包 zcc-html5-editor 使用教程

    前言 随着 Web 技术的发展,越来越多的 Web 应用需要使用富文本编辑器,而 zcc-html5-editor 就是一款功能强大且易于使用的富文本编辑器。本文将详细介绍如何在前端项目中使用 zcc...

    3 年前
  • npm 包 replacer-content 使用教程

    前言 在前端开发过程中,我们经常需要对页面进行一些字符串替换。对于手动替换,不仅耗费时间,也容易产生错误。因此,有一些工具可以帮助我们自动完成这些替换工作。其中一个比较好用的工具就是 npm 包 re...

    3 年前
  • npm包zzy-viewer使用教程

    介绍 zzy-viewer 是一款 npm 包,它是一个专用于前端图片的全屏查阅器,可以在浏览器中方便地查看多张图片。 特点: 基于原生 JavaScript 编写,无需依赖其他库。

    3 年前
  • npm 包 fastify-frame-guard 使用教程

    在前端开发中,网站安全性是一个十分重要的问题。其中之一就是如何防范网站被 Clickjacking 攻击。Clickjacking 就是利用 iframe 的透明度或者位置掩盖网页上的一些按钮,将用户...

    3 年前
  • npm 包 dom-to-image-extended 使用教程

    简介 dom-to-image-extended 是一个可以将网页元素转换为图片的工具,它是 dom-to-image 的一个扩展版本。通过使用此工具,您可以快速地将一个网页元素转换为图片,从而减轻对...

    3 年前
  • npm 包 @bemtools/gulp-extract-html-class 使用教程

    在前端开发中,随着项目规模的扩大,样式和 HTML 结构会变得越来越复杂。为了便于维护和管理,前端开发者们开始使用 BEM(Block、Element、Modifier)命名规范。

    3 年前
  • npm 包 husky-conf 使用教程

    介绍 husky-conf 是一个 npm 包,用于配置 husky(Git 钩子工具)的配置文件。husky-conf 解决了 husky 配置文件编写冗长、不易维护的问题,让配置变得更加简洁、易懂...

    3 年前
  • npm 包 ascom-chartist-tooltip 使用教程

    简介 ascom-chartist-tooltip 是一个基于 Chartist.js 的 npm 包,它能够为 Chartist.js 提供更丰富的 tooltip 功能。

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

    在前端开发过程中,我们经常会处理对象和 JSON 数据。在处理这些数据时,需要对其进行操作和验证,确保其数据结构正确。而在实际开发中,我们经常需要为对象添加默认值。

    3 年前

相关推荐

    暂无文章