Highlight.js 使用教程

2024-09-25 22:19:38作者：瞿蔚英Wynne

Highlight.js是一款强大的JavaScript语法高亮库，适用于网页与服务器端代码展示。它能无缝融入各种网页环境，无需依赖其他框架，且自带自动识别语言功能。无论是传统的`<pre><code>`标签还是自定义元素，通过简单的配置即可实现优雅的代码着色，支持超过180种编程和标记语言。开发者可享受其灵活的定制性，从手动控制高亮时机到集成Vue.js等框架，乃至在Web Worker中运行以防页面卡顿，让技术文档与代码分享既美观又高效。轻松获取通过CDN或NPM，适应各类开发流程，是提升代码展现力的不二之选。

项目地址：https://gitcode.com/gh_mirrors/hig/highlight.js

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 进行代码高亮显示。

highlight.js

项目地址：https://gitcode.com/gh_mirrors/hig/highlight.js

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

docs

OpenHarmony documentation | OpenHarmony开发者文档

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

Ascend Extension for PyTorch

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

openJiuwen agent-studio提供零码、低码可视化开发和工作流编排，模型、知识库、插件等各资源管理能力

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统