Highlight.js 使用教程
2024-09-25 22:02:36作者：瞿蔚英Wynne
1. 项目介绍
Highlight.js 是一个用 JavaScript 编写的语法高亮库，支持在浏览器和 Node.js 环境中使用。它能够自动检测代码语言并进行高亮显示，且不依赖于任何其他框架。Highlight.js 支持超过 180 种编程语言，并且可以通过第三方语言定义支持更多语言。
2. 项目快速启动
2.1 在浏览器中使用
在网页中使用 Highlight.js 的最简单方法是引入库和主题样式，然后调用 highlightAll 方法。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Highlight.js 示例</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<pre><code class="language-javascript">
console.log("Hello, World!");
</code></pre>
</body>
</html>
2.2 在 Node.js 中使用
在 Node.js 环境中，可以通过 require 或 import 引入 Highlight.js，并使用 highlightAuto 方法自动检测语言并高亮代码。
const hljs = require('highlight.js');
const code = '<h1>Hello World</h1>';
const highlightedCode = hljs.highlightAuto(code).value;
console.log(highlightedCode);
3. 应用案例和最佳实践
3.1 在博客中高亮代码
Highlight.js 常用于博客系统中，用于高亮显示文章中的代码片段，提升阅读体验。
3.2 在代码编辑器中使用
Highlight.js 也可以集成到代码编辑器中，用于实时高亮显示用户输入的代码。
3.3 最佳实践
- 自动检测语言：尽量使用
highlightAuto方法自动检测语言，减少手动指定语言的工作量。 - 自定义主题：根据网站风格选择合适的主题，或自定义主题以匹配网站设计。
- 性能优化：在处理大量代码时，考虑使用 Web Workers 或分块处理，避免阻塞主线程。
4. 典型生态项目
4.1 Vue.js 插件
Highlight.js 提供了 Vue.js 插件，可以方便地在 Vue 项目中使用 Highlight.js。
import Vue from 'vue';
import hljs from 'highlight.js';
import 'highlight.js/styles/default.css';
Vue.use(hljs.vuePlugin);
4.2 代码编辑器集成
Highlight.js 可以与各种代码编辑器集成，如 CodeMirror、Ace 等，提供语法高亮功能。
4.3 静态网站生成器
Highlight.js 常用于静态网站生成器（如 Jekyll、Hugo）中，用于高亮显示生成的 HTML 页面中的代码片段。
通过以上步骤，您可以快速上手并使用 Highlight.js 进行代码高亮显示。
相关内容推荐
热门项目推荐
鸿蒙开发工具大赶集本仓将收集和展示鸿蒙开发工具，欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南，并加上工具对应的链接，通过的工具将会成功上架到我们社区。012
hertzGo 微服务 HTTP 框架，具有高易用性、高性能、高扩展性等特点。Go01
每日精选项目🔥🔥 每日精选已经升级为：【行业动态】，快去首页看看吧，后续都在【首页 - 行业动态】内更新，多条更新哦～🔥🔥 每日推荐行业内最新、增长最快的项目，快速了解行业最新热门项目动态~~029- kitexGo 微服务 RPC 框架，具有高性能、强可扩展的特点。Go00
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie057- 毕方Talon工具本工具是一个端到端的工具，用于项目的生成IR并自动进行缺陷检测。Python040
PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译，支持 Google/DeepL/Ollama/OpenAI 等服务，提供 CLI/GUI/DockerPython06
mybatis-plusmybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03
国产编程语言蓝皮书《国产编程语言蓝皮书》-编委会工作区018- DDeepSeek-R1探索新一代推理模型，DeepSeek-R1系列以大规模强化学习为基础，实现自主推理，表现卓越，推理行为强大且独特。开源共享，助力研究社区深入探索LLM推理能力，推动行业发展。【此简介由AI生成】Python00
热门内容推荐
最新内容推荐
项目优选
收起
Python-100-DaysPython - 100天从新手到大师
Python
610
115
HarmonyOS-Examples本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！
Cangjie
286
79
md✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器：支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性
Vue
111
25
openHiTLS旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！
C
60
48
RuoYi-Cloud-Vue3🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29
go-stock🦄🦄🦄AI赋能股票分析：自选股行情获取，成本盈亏展示，涨跌报警推送，市场整体/个股情绪分析，K线技术指标分析等。数据全部保留在本地。支持DeepSeek，OpenAI， Ollama，LMStudio，AnythingLLM，硅基流动，火山方舟，阿里云百炼等平台或模型。
Go
1
0
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
57
MateChat前端智能化场景解决方案UI库，轻松构建你的AI应用，我们将持续完善更新，欢迎你的使用与建议。
官网地址：https://matechat.gitcode.com
376
36
RuoYi-Vue🎉 基于SpringBoot，Spring Security，JWT，Vue & Element 的前后端分离权限管理系统，同时提供了 Vue3 的版本
Java
182
44
frog这是一个人工生命试验项目，最终目标是创建“有自我意识表现”的模拟生命体。
Java
8
0