百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术教程 > 正文

Highlight.js - 前端的代码语法高亮库

suiw9 2024-11-09 14:50 21 浏览 0 评论

千辛万苦写了篇技术分享,贴了一堆代码,兴高采烈地发到了自己的博客网站上。结果却发现代码全是白底黑字,字体还难看得很,你瞬间就没了兴致。能不能让网页也能像 IDE 那样,做带语法高亮的炫酷显示呢?来看一看 Highlight.js 吧,看这个语法高亮库如何点亮你的代码。

简介

Highlight.js,是在 Github 上由 highlight.js 组织开源的前端代码语法高亮库,代码仓库在 https://github.com/highlightjs/highlight.js,目前版本为 10.1.0。其不依赖于任何框架,自带对于大量编程语言和标记语言的语法高亮规则,和主流的高亮色彩方案,且可以自由扩展。其支持自动语言检测,使用极为方便,是在网页上进行语法高亮的不二之选。

安装

Highlight.js 的 CSS 文件的选择决定高亮配色方案,默认为 Default,另外还有如 Monokai Sublime、Ocean、Solarized Dark、Tomorrow 等经典的主流配色方案。

而 JS 文件的选择决定可以支持的语言。主要的 highlight.min.js 包含了一些主流的语言,包括 C++、XML、Markdown、Java 等。如果需要一些其他的语言,则要另外引用该语言对应JS文件。

Highlight.js 在浏览器中可以简单的引用 CDN 来使用:

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.0/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.0/highlight.min.js"></script>

示例

Highlight.js 使用十分简单,在引用了 CSS 和 JS 后,执行

hljs.initHighlightingOnLoad();

Highlight.js就会自动查找网页中以标签 pre 和 code 所包裹的代码

<pre><code>...</code></pre>

并自动检测代码语言,进行高亮渲染。我们也可以为 code 标签添加语言名称的 class,来显式地标明代码语言。我们可以看一个使用示例,注意实际代码中尖括号等 HTML 转义字符需要进行转义处理:

<html>
<head>
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.0/styles/monokai-sublime.min.css">
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.0/highlight.min.js"></script>
</head>
<body>
  <pre><code class="cpp">#include <iostream>

int main(int argc, char *argv[]) {

    /* An annoying "Hello World" example */
    for (auto i = 0; i < 0xFFFF; i++)
        cout << "Hello, World!" << endl;

    char c = '\n';
    unordered_map <string, vector<string> > m;
    m["key"] = "\\\\"; // this is an error

    return -2e3 + 12l;
}
  </code></pre>
  <script>
    hljs.initHighlightingOnLoad();
  </script>
</body>
</html>

该网页对于 C++ 语言片段使用了 Monokai Sublime 主题进行了语法高亮渲染:

可以看到,包括关键字、注释和字面值等都有了不同颜色的渲染,输出十分美观。以下则是使 Dracula 主题对 Javascript 代码渲染的例子:

我们也可以不使用 pre 和 code 标签来包裹代码,改为使用自定义的容器,使用时需要注意换行和等宽字体的问题。

document.querySelectorAll('div.code').forEach((block) => {
  hljs.highlightBlock(block);
});

在渲染大量代码时,为避免浏览器卡死,可以使用 Web Worker 来在后台进行渲染:

// index.html
addEventListener('load', () => {
  const code = document.querySelector('#code');
  const worker = new Worker('worker.js');    // 新建Worker
  worker.onmessage = (event) => { code.innerHTML = event.data; }    // 接受渲染后的HTML
  worker.postMessage(code.textContent);    // 传递代码
});
// worker.js
onmessage = (event) => {
  importScripts('<path>/highlight.min.js');
  const result = self.hljs.highlightAuto(event.data);    // 高亮渲染
  postMessage(result.value);    // 返回HTML
};

总结

Highlight.js 使得在前端页面进行语法高亮变得十分方便,为在网页显示的代码增添了颜色和生机。

Highlight.js 文档详尽,设计简洁,为编写新的语言支持和配色方案提供了很大支持,定制化能力和可扩展性极强。Highlight.js 的代码包含了对于各种语言的语法解析,和不同配色方案的设计,对于对编程语言和语法高亮领域感兴趣的开发者是一座珍贵的宝库。

相关推荐

分布式系统核心概念及实现(分布式核心原理解析)

一、分布式系统核心概念1.分布式系统的定义分布式系统是由多个独立的计算机(节点)通过网络连接,协同完成任务的系统。这些节点可以是物理机、虚拟机或容器。...

nosql之mongodb(nosql数据库是国产的吗)

什么是MongoDB?MongoDB是由C++语言编写的,是一个基于分布式文件存储的开源数据库系统。...

如何治理非结构化数据?(非结构化化数据)

据调查,当前企业80%的数据为非结构化数据或半结构化数据,而结构化数据是他们管理的重点,非结构化数据却被忽视。然而,非结构化数据也有着它的价值。那么,如何治理非结构化数据?IDC调研显示,目前企业中8...

Cloudera收购大数据加密初创企业Gazzang

Hadoop供应商Cloudera刚刚收购了专门研究下一代数据存储环境加密技术技术的初创企业Gazzang,但交易细节并未透露。这是Cloudera的第一笔重大收购。Gazzang成立于20...

全网最全95道MongoDB面试题1万字详细解析

1、mongodb是什么?MongoDB是由C++语言编写的,是一个基于分布式文件存储的开源数据库系统。在高负载的情况下,添加更多的节点,可以保证服务器性能。MongoDB旨在给WEB应...

mongodb——视图(mongodb object)

MongoDB视图是一个可查询的对象,其内容由其他集合或视图上的聚合管道定义。MongoDB不会将视图内容持久化到磁盘。当客户端查询视图时,MongoDB可以要求客户端拥有查询视图的权限。MongoD...

mongodb的优缺点及应用场景(mongodb 优点 应用场景)

一、MongoDB是什么1、维基百科MongoDB是一个基于分布式文件存储的数据库。由C++语言编写。旨在为WEB应用提供可扩展的高性能数据存储解决方案。...

5款Syslog集中系统日志常用工具对比推荐

一、为何要集中管理Syslog?Syslog由Linux/Unix系统及其他网络设备生成,广泛分布于整个网络。因其包含关键信息,可用于识别网络中的恶意活动,所以必须对其进行持续监控。将Sys...

跨平台、多数据库支持的开源数据库管理工具——DBeaver

简介今天给大家推荐一个开源的数据库管理工具——DBeaver。它支持多种数据库系统,包括Mysql、Oracle、PostgreSQL、SLQLite、SQLServer等。DBeaver的界面友好...

强烈推荐!数据库管理工具:Navicat Premium 16.3.2 (64位)

NavicatPremium,一款集数据迁移、数据库管理、SQL/查询编辑、智能设计、高效协作于一体的全能数据库开发工具。无论你是MySQL、MariaDB、MongoDB、SQLServer、O...

3 年 Java 程序员还玩不转 MongoDB,网友:失望

一、什么场景使用MongoDB?...

拯救MongoDB管理员的GUI工具大赏:从菜鸟到极客的生存指南

作为一名在NoSQL丛林中披荆斩棘的数据猎人,没有比GUI工具更称手的瑞士军刀了。本文将带你围观五款主流MongoDB管理神器的特性与暗坑,附赠精准到扎心的吐槽指南一、MongoDBCompass:...

mongodb/redis/neo4j 如何自己打造一个 web 数据库可视化客户端?

前言最近在做neo4j相关的同步处理,因为产线的可视化工具短暂不可用,发现写起来各种脚本非常麻烦。...

solidworks使用心得,纯干货!建议大家收藏

SolidWorks常见问题...

统一规约-关乎数字化的真正实现(规范统一性)

尽管数字化转型的浪潮如此深入人心,但是,对于OPCUA和TSN的了解却又甚少,这难免让人质疑其可实现性,因为,如果缺乏统一的语义互操作规范,以及更为具有广泛适用的网络与通信,则数字化实际上几乎难以具...

取消回复欢迎 发表评论: