highlight.js

highlight.js

多语言支持的代码语法高亮工具

Highlight.js是一款用JavaScript开发的代码语法高亮工具,可在浏览器和服务器环境中使用。它支持180多种编程语言,具有自动语言检测功能,无需依赖其他框架。该工具易于集成,支持CDN引入、自定义构建和模块化导入。Highlight.js还提供多种主题样式,可根据需求进行定制。

Highlight.js语法高亮JavaScript代码高亮开源项目Github

Highlight.js

最新版本 许可证 安装大小 压缩后大小 每周NPM下载量 jsDelivr CDN下载量 CI状态 CodeQL 漏洞 discord 未解决问题 欢迎帮助的问题 适合新手的问题

Highlight.js是一个用JavaScript编写的语法高亮器。它可以在浏览器和服务器上运行。它几乎可以处理任何标记,不依赖于任何其他框架,并且具有自动语言检测功能。

目录


升级到版本11

与往常一样,主要版本确实包含可能需要用户采取行动的重大更改。请阅读VERSION_11_UPGRADE.md以获取重大更改的详细摘要以及您可能需要采取的任何措施。

对旧版本的支持

请参阅SECURITY.md以获取长期支持信息。


基本用法

在浏览器中使用

在网页上使用highlight.js的最简单方法是链接到库和其中一个主题,然后调用[highlightAll][1]:

<link rel="stylesheet" href="/path/to/styles/default.min.css"> <script src="/path/to/highlight.min.js"></script> <script>hljs.highlightAll();</script>

这将查找并高亮显示<pre><code>标签内的代码;它会尝试自动检测语言。如果自动检测对您不起作用,或者您只是更喜欢明确指定,可以使用class属性手动指定语言:

<pre><code class="language-html">...</code></pre>

纯文本代码块

要将Highlight.js的样式应用于纯文本而不实际高亮显示它,请使用plaintext语言:

<pre><code class="language-plaintext">...</code></pre>

忽略代码块

要完全跳过对代码块的高亮显示,请使用nohighlight类:

<pre><code class="nohighlight">...</code></pre>

在服务器上使用Node.js

自动检测语言并高亮显示一些代码的最简单方法。

// 加载库和所有语言 hljs = require('highlight.js'); html = hljs.highlightAuto('<h1>Hello World!</h1>').value

要只加载"常见"子集的流行语言:

hljs = require('highlight.js/lib/common');

要用特定语言高亮显示代码,请使用highlight

html = hljs.highlight('<h1>Hello World!</h1>', {language: 'xml'}).value

有关requireimport用法等的更多示例,请参阅导入库。有关highlighthighlightAuto返回的结果对象的更多信息,请参阅API文档

支持的语言

Highlight.js在核心库中支持超过180种语言。还有第三方语言定义可用于支持更多语言。您可以在[SUPPORTED_LANGUAGES.md][9]中找到支持的语言的完整列表。

自定义用法

如果您需要对Highlight.js的初始化进行更多控制,可以使用[highlightElement][3]和[configure][4]函数。这允许您更好地控制要高亮显示的内容何时高亮显示

例如,这里是手动执行等同于调用[highlightAll][1]的粗略等效代码:

document.addEventListener('DOMContentLoaded', (event) => { document.querySelectorAll('pre code').forEach((el) => { hljs.highlightElement(el); }); });

请参阅[configure][4]选项的文档。

使用自定义HTML

我们强烈建议使用<pre><code>包装代码块。这在语义上很合理,并且"开箱即用",无需任何调整。可以使用其他HTML元素(或组合),但您可能需要特别注意保留换行符。

假设您的代码块标记使用div:

<div class='code'>...</div>

要手动高亮显示此类块:

// 首先,找到所有的div.code块 document.querySelectorAll('div.code').forEach(el => { // 然后高亮显示每个 hljs.highlightElement(el); });

如果不使用保留换行符的标签(如pre),您需要一些额外的CSS来帮助保留它们。您也可以使用插件预处理和后处理换行符,但我们建议使用CSS

要使用CSS在div内保留换行符:

div.code { white-space: pre; }

与Vue.js一起使用

请参阅highlightjs/vue-plugin以获取一个简单的Vue插件,它可以很好地与Highlight.js配合使用。

vue-plugin使用示例:

<div id="app"> <!-- 绑定到名为`code`的数据属性 --> <highlightjs autodetect :code="code" /> <!-- 或者文字代码也可以 --> <highlightjs language='javascript' code="var x = 5;" /> </div>

使用Web Workers

您可以在Web Worker中运行高亮显示,以避免在处理非常大的代码块时冻结浏览器窗口。

在主脚本中:

addEventListener('load', () => { const code = document.querySelector('#code'); const worker = new Worker('worker.js'); worker.onmessage = (event) => { code.innerHTML = event.data; } worker.postMessage(code.textContent); });

在worker.js中:

onmessage = (event) => { importScripts('<path>/highlight.min.js'); const result = self.hljs.highlightAuto(event.data); postMessage(result.value); };

导入库

首先,您可能会通过npmyarn安装库 - 请参阅获取库

Node.js / require

引入顶级库将加载所有语言:

// 引入highlight.js库,包括所有语言 const hljs = require('./highlight.js'); const highlightedCode = hljs.highlightAuto('<span>Hello World!</span>').value

为了减少占用空间,加载我们的常用语言子集(与我们默认的Web构建使用的集合相同):

const hljs = require('highlight.js/lib/common');

要获得最小的占用空间,只加载您需要的语言:

const hljs = require('highlight.js/lib/core'); hljs.registerLanguage('xml', require('highlight.js/lib/languages/xml')); const highlightedCode = hljs.highlight('<span>Hello World!</span>', {language: 'xml'}).value

ES6模块 / import

注意:您也可以直接从完全静态的URL导入,例如我们自己预构建的ES6模块CDN资源。有关具体示例,请参阅通过CDN获取

默认导入将注册所有语言:

import hljs from 'highlight.js';

只导入库并注册您需要的语言更有效:

import hljs from 'highlight.js/lib/core'; import javascript from 'highlight.js/lib/languages/javascript'; hljs.registerLanguage('javascript', javascript);

如果您的构建工具处理CSS导入,您也可以直接将主题作为模块导入:

import hljs from 'highlight.js'; import 'highlight.js/styles/github.css';

获取库

您可以获取highlight.js作为托管的或自定义构建的浏览器脚本或服务器模块。开箱即用,浏览器脚本同时支持AMD和CommonJS,因此如果您愿意,可以使用RequireJS或Browserify而无需从源代码构建。服务器模块也可以完美地与Browserify配合使用,但还有一个选项可以使用专门针对浏览器而不是服务器的构建。

**不要直接链接到GitHub。**该库不应直接从源代码运行,它需要构建。如果预打包的选项都不适合您,请参阅[构建文档][6]。

**关于Almond。**您需要使用优化器为模块指定名称。例如:

r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js

通过CDN获取

Highlight.js的预构建版本(捆绑了许多常见语言)由几个流行的CDN托管。 通过CDN使用Highlight.js时,您可以使用子资源完整性来增加安全性。有关详细信息,请参阅DIGESTS.md

cdnjs (链接)

常见JS
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/default.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/highlight.min.js"></script> <!-- 还可以轻松单独加载其他语言 --> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/languages/go.min.js"></script>
ES6模块
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.10.0/styles/dark.min.css"> <script type="module"> import hljs from

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多