npm 包 hypelight 使用教程

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

在 Web 开发中,代码高亮是一个非常常见的需求。一般情况下,我们可以使用一些库来实现代码高亮,比如 highlight.jsPrism 等。这些库都能够很好地实现代码高亮,但是它们的体积比较大,而且有时候需要手动配置语言支持,使用起来较为麻烦。

今天我们来介绍一个轻量级的代码高亮库——hypelight。hypelight 体积小、不依赖第三方库,支持自动检测代码语言,使用起来非常方便。

安装

hypelight 可以通过 npm 安装:

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

也可以用 yarn 安装:

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

使用

hypelight 的使用非常简单,只需要引入 hypelight 的 CSS 和 JS 文件,然后在要高亮显示的代码块上添加 hljs 类名即可,如下所示:

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

如果要使用其他语言的高亮,只需要在 code 标签的的 class 属性中添加对应的语言类名即可,如下所示:

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

支持的语言包括:

  • apache
  • bash
  • cpp
  • cs
  • css
  • diff
  • http
  • ini
  • java
  • javascript
  • json
  • makefile
  • markdown
  • nginx
  • objectivec
  • php
  • python
  • ruby
  • sql
  • swift
  • xml

自定义样式

hypelight 提供了一些自定义样式的选项,用户可以根据自己的需要进行修改。下面是一些常见的自定义样式选项及其作用:

hljs.default

该样式表示默认的代码高亮样式,如果不想修改其他样式,只是想改变代码高亮的样式,可以修改该样式。

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

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

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

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

hljs.comment

该样式表示注释的样式。

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

hljs.string

该样式表示字符串的样式。

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

hljs.number

该样式表示数字的样式。

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

hljs.function

该样式表示函数的样式。

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

总结

hypelight 是一个轻量级的代码高亮库,体积小、使用方便。在实际开发中,利用它可以让我们的代码更加清晰易懂,提高代码阅读体验。

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


猜你喜欢

  • npm 包 zetta-auto-scout 使用教程

    随着智能家居市场的发展,越来越多的智能设备进入到我们的生活中。在这样的背景下,为了方便开发者进行智能设备的开发,开源社区不断推出各种工具,其中 npm 包 zetta-auto-scout 是一款非常...

    4 年前
  • npm 包 minimatch-with-regex 使用教程

    简介 minimatch-with-regex 是一个基于 minimatch 的 npm 包,可以通过正则表达式进行文件匹配。对于前端工程师来说,它可以方便地在打包构建、代码压缩等环节中,根据正则表...

    4 年前
  • npm 包 zetta-events-stream-protocol 使用教程

    前言 在前端开发中,使用 npm 包可以方便地管理和引入代码,提高开发效率。本文将介绍一个 npm 包 zetta-events-stream-protocol,通过详细的使用教程以及示例代码,帮助读...

    4 年前
  • NPM 包 zetta-http-device 使用教程

    需求背景 在前端开发中,我们经常需要和后端进行数据交互。在一些 IOT 项目中,需要通过设备来获取数据,这就需要在前端中调用一些设备服务。为了方便我们的开发,npm 提供了很多库或框架,其中 zett...

    4 年前
  • NPM包zetta-memory-registry 使用教程

    介绍 zetta-memory-registry是一个基于内存的注册表模块,用于在zetta服务器应用程序中存储设备和其属性。它是npm包zetta的一部分,可将其与其他zetta模块一起使用。

    4 年前
  • npm 包 zetta-cluster 使用教程

    zetta-cluster 是一个 npm 包,用于创建基于 Zetta 的分布式系统。本文将介绍 zetta-cluster 的使用教程,包括如何安装和使用该包,以及示例代码和深度解析。

    4 年前
  • npm 包 @dmail/project-structure 使用教程

    在 Web 前端开发中,项目结构的组织是至关重要的。好的项目结构可以让我们更好地组织代码、提高开发效率,让团队协作更加高效。本文将介绍一款非常实用的 npm 包 @dmail/project-stru...

    4 年前
  • NPM 包 @dmail/inspect 使用教程

    什么是 @dmail/inspect @dmail/inspect 是一个可以帮助前端开发者调试 JavaScript 代码的 npm 包。它提供了一种简单易用的方式来输出对象的详细信息以及跟踪异步调...

    4 年前
  • npm包 @dmail/assert使用教程

    前言 在前端开发中,我们经常需要进行单元测试来保证代码质量和稳定性。而编写单元测试时,断言是不可或缺的一部分。本文将介绍一个npm包——@dmail/assert,它是一个易于使用的断言库,可以帮助我...

    4 年前
  • npm 包 @jsenv/babel-plugin-description 使用教程

    简介 在前端开发中,使用 Babel 可以让我们使用最新的语法特性,进行 ES6+ 的开发。而在 Babel 的使用过程中,我们常常需要对源代码进行一些额外的处理,比如添加描述信息。

    4 年前
  • npm 包 @jsenv/eslint-import-resolver 使用教程

    前言 在前端开发过程中,我们必须要保持代码品质,其中一个重要的方面就是统一的代码规范。而 eslint 就可以帮我们实现这一点。但是,在大型项目中,文件数量较多,文件之间的依赖关系也较为复杂,这就需要...

    4 年前
  • npm 包 @jsenv/href 使用教程

    在前端开发中,我们经常需要构建一个有多个页面的网站。如果每个链接都需要手动地去写成 href 形式,那么就会非常不便。针对这个情况,npm 包 @jsenv/href 提供了一种非常便捷的方式去生成链...

    4 年前
  • npm 包 @jsenv/bundling 使用教程

    前言 在前端开发中,常常需要将多个 JavaScript 文件打包成一个或多个文件来提高网站或应用的性能。传统的打包工具如 webpack、rollup 等都是非常优秀的选择,但是它们的配置可能过于复...

    4 年前
  • npm 包 @jsenv/chromium-launcher 使用教程

    前言 对于前端开发者而言,测试是不可或缺的环节。一般情况下,我们会使用现代浏览器的开发工具进行调试,但在某些情况下,我们需要在一个全新且无状态的浏览器环境中进行测试,以确保每个用户都能得到一致的体验。

    4 年前
  • npm 包 @jsenv/execution 使用教程

    简介 @jsenv/execution 是一个 Node.js 模块,用于执行 JavaScript 代码并输出结果。 它提供了一个简单的 API,使得在 Node.js 中执行 JavaScript...

    4 年前
  • npm 包 @jsenv/exploring-server 的使用教程

    本文介绍如何使用 npm 包 @jsenv/exploring-server 来搭建一个简单的服务器,并以此为基础,进一步了解前端开发中的服务端相关知识点。 什么是 @jsenv/explorin...

    4 年前
  • npm 包 @jsenv/error-stack-sourcemap 使用教程

    在前端开发中,经常会遇到错误调试时难以定位代码行数的问题。这时我们就可以使用 @jsenv/error-stack-sourcemap 这个 npm 包来解决这个问题。

    4 年前
  • npm 包 @jsenv/node-launcher 使用教程

    介绍 在前端开发过程中,我们时常需要在本地搭建一个 Node.js 开发环境来调试代码。然而,如果我们需要在多个不同的项目中使用不同的 Node.js 版本,或需要在不同的操作系统上使用相同的版本,就...

    4 年前
  • npm 包 @dmail/cancellation 使用教程

    什么是 @dmail/cancellation 在编写异步代码时,我们常常需要处理取消操作。例如,用户可能在异步操作还未完成时,关闭了当前页面或停止了原本的操作,这对于异步任务来说就是一个取消操作。

    4 年前
  • npm 包 @dmail/filesystem-matching 使用教程

    @dmail/filesystem-matching 是一个用于在 Node.js 中进行文件系统匹配的 npm 包。它提供了一组简单但强大的工具,可以帮助开发者快速地扫描文件系统中的文件,以获取他们...

    4 年前

相关推荐

    暂无文章