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 包 byted-player-shaka 使用教程

    本文将介绍如何使用 npm 包 byted-player-shaka 来实现基于 Shaka Player 的视频播放器。该播放器支持多种流媒体协议,而且可扩展性强,适用于各种前端项目。

    3 年前
  • npm 包 jquery-ajax-unobtrusive-multi 使用教程

    在前端开发中,我们常常需要使用 AJAX 技术来实现页面与服务器的数据交互。而 jquery-ajax-unobtrusive-multi 是一个方便的 jQuery 插件,可以让我们用更加简单的方式...

    3 年前
  • npm 包 koa-router3 使用教程

    什么是 koa-router3 koa-router3 是 koa2.x 的路由中间件,它的主要功能是将请求分发到不同的路由回调函数中,从而实现路由控制。与 Express 的路由中间件相比较,koa...

    3 年前
  • npm 包 eslint-config-emakinacee-angular 使用教程

    作为前端开发者,代码规范的重要性不言而喻。其中,ESLint 是一个常用的 JavaScript 代码检查工具,它可以帮助我们发现一些常见错误或者潜在问题,进而提高代码质量和可读性。

    3 年前
  • npm 包 eslint-config-emakinacee-react 使用教程

    在前端开发中,我们经常会遇到代码质量的问题,这时候一个好用的 eslint 工具就能够有效地解决这些问题。本文将介绍一个名为 eslint-config-emakinacee-react 的 npm ...

    3 年前
  • npm 包 koa2-rest 使用教程

    在使用 Node.js 开发 Web 应用的过程中,我们经常需要使用一些框架和工具,以便更高效的编写代码。其中,Koa2 是一种轻量级的 Web 框架,而 koa2-rest 是 Koa2 的一个中间...

    3 年前
  • npm 包 web3-ssl-ext 使用教程

    什么是 web3-ssl-ext web3-ssl-ext 是一个 npm 包,它是 web3.js 的增强版,用于与以太坊网络进行通信。不同的是,web3-ssl-ext 支持 HTTPS 连接以太...

    3 年前
  • npm 包 gulp-babel-istanbul-reborn 使用教程

    在前端开发中,测试是非常重要的一环。而在测试过程中,代码覆盖率也是一个重要的指标,它可以帮助我们检测测试中可能存在的盲点,提高代码的质量。gulp-babel-istanbul-reborn 是一个能...

    3 年前
  • npm 包 env-dsl 使用教程

    简介 env-dsl 是一个 Node.js 库,用于读取环境变量并返回一个对象,以方便在 Node.js 应用程序中使用。其也被称为环境变量 DSL(Domain Specific Language...

    3 年前
  • npm 包 summery-cli 使用教程

    简介 summery-cli 是一个基于 Node.js 的命令行工具,可以将文本内容转换为摘要,并输出到终端或写入文件中。它支持中文分词、词频统计、停用词过滤等多种分析方式,可以很好地帮助我们快速生...

    3 年前
  • NPM 包 @brencon/organize-photos 使用教程

    在前端开发中,经常会需要处理图片及其相关数据的组织和管理,而 @brencon/organize-photos 是一款可以帮助我们解决这个问题的 NPM 包。本文就为大家详细介绍一下 @brencon...

    3 年前
  • npm 包 @starters/typescript 使用教程

    作为前端开发者,我们经常会使用到 TypeScript 来编写代码。而在 TypeScript 中,我们又会经常使用到一些工具包,来辅助我们更加高效地完成开发工作。

    3 年前
  • npm 包 @supcon/redux-undo-redo 使用教程

    介绍 在前端应用中,我们通常会使用 Redux 来管理应用的状态。而在 Redux 中,有一个非常重要的概念,那就是状态的不可变性。这意味着我们不能直接修改状态,而是需要通过 dispatch 一个 ...

    3 年前
  • npm 包 eslint-config-emakinacee-base 使用教程

    ESLint 是一个 JavaScript 代码检查工具,它可以帮助我们检测代码中的潜在问题并提供建议和修复。 eslint-config-emakinacee-base 是一个 ESLint 配置包...

    3 年前
  • npm包query-string-encode使用教程

    在前端开发中,通常需要将 URL 查询字符串解析为 JavaScript 对象或将 JavaScript 对象序列化为 URL 查询字符串。因此,使用 query-string-encode 这个 n...

    3 年前
  • npm 包 jtk 使用教程

    什么是 jtk? jtk 是一款轻量级的 JavaScript 工具库,主要用于处理鼠标和键盘事件。它实现了鼠标拖拽、缩放、旋转、多点触控和键盘控制等常用交互功能,同时支持事件监听和回调,易于扩展和集...

    3 年前
  • npm 包 react-cli-test 使用教程

    如果你是一个前端工程师,你一定会听说过 npm 包管理工具,它可以帮助开发者轻松地分享和安装代码库。而今天,我们要介绍的是一款针对 React 开发者的 npm 包——react-cli-test,该...

    3 年前
  • npm 包 node-red-contrib-process-env 使用教程

    在开发前端应用程序的过程中,我们经常需要处理各种环境变量。而这些环境变量可能来源于命令行参数、配置文件或者系统环境变量等。Node.js 的 process 对象提供了方便的接口来访问这些环境变量。

    3 年前
  • npm 包 fsl-async 使用教程

    在前端开发中,异步操作是非常常见的。fsl-async 是一个帮助处理异步操作的 npm 包。本文将详细介绍 fsl-async 的使用教程,包括其特性和方法,以及常见的使用场景。

    3 年前
  • npm 包 koa-wxapp-auth 使用教程

    在前端开发中,我们经常会用到各种技术和工具来完成开发任务,其中 npm 是包管理和构建工具的首选之一。而 koa-wxapp-auth 作为一个 npm 包,可以帮助我们在小程序中进行用户授权和登录等...

    3 年前

相关推荐

    暂无文章