Highlight.js是用JavaScript編寫的語法突出顯示工具。它在瀏覽器和服務器上均可使用。它幾乎可以與任何標記一起使用,不依賴于任何框架,并且具有自動語言檢測功能。
本站下載:
頁底文件來源于Github,于2019年11月19號下載。

- 185種語言和90種樣式
- 自動語言檢測
- 多語言代碼突出顯示
- 可用于node.js
- 適用于任何標記
- 與任何js框架兼容
如何使用?
來源于: https://highlightjs.org/usage/
入門
在網頁上使用Highlight.js的最低要求是將鏈接到庫以及其中一種樣式并調用?initHighlightingOnLoad
:
<link rel="stylesheet" href="/path/to/styles/default.css">
<script src="/path/to/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
這將在<pre><code>
標簽內找到并突出顯示代碼;它會嘗試自動檢測語言。如果自動檢測對您不起作用,則可以在class
屬性中指定語言:
<pre><code class="html">...</code></pre>
支持的語言和相應類的列表。
類也可以使用language-
或作為前綴lang-
。
要使任意文本看起來像代碼,但不突出顯示,請使用?plaintext
此類:
<pre><code class="plaintext">...</code></pre>
要完全禁用突出顯示,請使用nohighlight
類:
<pre><code class="nohighlight">...</code></pre>
自定義初始化
當需要對Highlight.js的初始化進行更多控制時,可以使用highlightBlock
和configure
?函數。這可以讓你控制什么突出和時。
這是initHighlightingOnLoad
使用普通JS?調用的等效方法:
document.addEventListener('DOMContentLoaded', (event) => {
document.querySelectorAll('pre code').forEach((block) => {
hljs.highlightBlock(block);
});
});
您可以使用任何標簽代替<pre><code>
標記代碼。如果您不使用保留換行符的容器,則需要配置highlight.js以使用<br>
標記:
hljs.configure({useBR: true});
document.querySelectorAll('div.code').forEach((block) => {
hljs.highlightBlock(block);
});
有關其他選項,請參閱的文檔configure
。
網絡工作者
您可以在網絡工作者中運行突出顯示功能,以避免在處理非常大的代碼塊時凍結瀏覽器窗口。
在您的主腳本中:
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.pack.js');
const result = self.hljs.highlightAuto(event.data);
postMessage(result.value);
};
Node.js
您可以在節點上使用highlight.js突出顯示內容,然后再將其發送到瀏覽器。確保使用該.value
屬性獲取格式化的html。有關返回的對象的更多信息,請參考api docs https://highlightjs.readthedocs.io/en/latest/api.html
// require the highlight.js library including all languages
const hljs = require('./highlight.js');
const highlightedCode = hljs.highlightAuto('<span>Hello World!</span>').value
// require the highlight.js library without languages
const hljs = require("highlight.js/lib/highlight.js");
// separately require languages
hljs.registerLanguage('html', require('highlight.js/lib/languages/html'));
hljs.registerLanguage('sql', require('highlight.js/lib/languages/sql'));
// highlight with providing the language
const highlightedCode = hljs.highlight('html', '<span>Hello World!</span>').value
獲取圖書館
您可以將Highlight.js作為托管或自定義構建的瀏覽器腳本或作為服務器模塊來獲取。即開即用的瀏覽器腳本同時支持AMD和CommonJS,因此,如果您希望可以使用RequireJS或Browserify,而無需從源代碼進行構建。服務器模塊也可以與Browserify完美配合,但是可以選擇使用特定于瀏覽器的版本,而不是用于服務器的版本。前往下載頁面以獲取所有選項。
不要直接鏈接到GitHub。該庫不應直接從源頭工作,它需要構建。如果沒有任何預包裝的選項對您有效,請參考建筑文檔。
CDN托管的軟件包沒有所有的語言。否則它將太大。如果您在“通用”部分中沒有看到所需的語言,則可以手動添加:
<script
charset="UTF-8"
src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.9/languages/go.min.js"></script>
在杏仁上。您需要使用優化器為模塊命名。例如:
r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
普通JS
您可以將Highlight.js導入為CommonJS模塊:
npm install highlight.js --save
在您的應用程序中:
import hljs from 'highlight.js';
默認導入會導入所有語言!因此,僅導入所需的庫和語言可能會更有效:
import hljs from 'highlight.js/lib/highlight';
import javascript from 'highlight.js/lib/languages/javascript';
hljs.registerLanguage('javascript', javascript);
要設置語法突出顯示樣式,如果構建工具從JavaScript入口點處理CSS,則可以將樣式表直接導入到CommonJS模塊中:
import hljs from 'highlight.js/lib/highlight';
import 'highlight.js/styles/github.css';
執照
Highlight.js是在BSD許可下發布的。有關詳細信息,請參見LICENSE文件。