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 进行代码高亮显示。
热门项目推荐
- CangjieCommunity为仓颉编程语言开发者打造活跃、开放、高质量的社区环境Markdown6690
- redis-sdk仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。Cangjie32226
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTypeScript15.77 K1.47 K
- Yi-CoderYi Coder 编程模型,小而强大的编程助手305
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript75.83 K19.04 K
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript35.51 K4.79 K
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总252
- AanacondaAnaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3Python2.22 K263
- Wwindows暂无简介Shell16.14 K1.35 K
- byzer-langByzer(以前的 MLSQL):一种用于数据管道、分析和人工智能的低代码开源编程语言。Scala1.88 K551
热门内容推荐
展开
最新内容推荐
展开
项目优选
收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
10
4
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K