技術文章的閱讀體驗,很大一部分取決於程式碼區塊好不好讀。highlight.js 就是專門解決這件事的 JavaScript 語法高亮庫,目前支援 125 種程式語言、內建 63 種配色主題,還能做語言自動偵測,並與主流 JS 框架相容、可混用。
它最適合被放進部落格或文件系統中,而使用門檻幾乎為零,不需要任何學習成本。以下逐步說明。
1. 取得 highlight.js
可以從官方網站下載:
地址:https://highlightjs.org/download/

官網支援線上客製,只要勾選需要的語言再下載即可,體積會比下載完整包小很多。若懶得挑,直接按預設選項下載就行:

或者點擊此處本站下載。
2. 解壓後的檔案結構

其中 styles 目錄收著所有配色主題的 CSS,highlight.pack.js 則是壓縮後的核心函式庫。
3. 在頁面中引入樣式與腳本
<link rel="stylesheet" href="highlight/styles/default.css"> <script src="highlight/highlight.pack.js"</script>
4. 啟動高亮
<script> hljs.initHighlightingOnLoad(); </script>
5. 把要上色的程式碼放進 pre 與 code
<pre> <code class="php"> <?php // 使用 substr_replace 函數進行字符串插入操作 demo $str = "歡迎來到"; echo substr_replace($str, "\"PHP大神\"", 4, 0); // 輸出:歡迎"PHP大神"來到 ?> </code> </pre>
class 屬性用來指定語言別,上例宣告為 php。若不指定,highlight.js 會嘗試自動偵測,準確率通常相當不錯。
完整可執行範例
<!DOCTYPE html> <html> <head lang="en"> <meta charset="UTF-8"> <title>HighLightjs</title> <link rel="stylesheet" href="highlight/styles/default.css"> <script src="highlight/highlight.pack.js"</script> </head> <body> <script> hljs.initHighlightingOnLoad(); </script> <pre> <code class="php"> <?php // 使用 substr_replace 函數進行字符串插入操作 demo $str = "歡迎來到"; echo substr_replace($str, "\"PHP大神\"", 4, 0); // 輸出:歡迎"PHP大神"來到 ?> </code> </pre> </body> </html>
預覽效果如下圖:

實務上的兩個提醒
第一,程式碼區塊內若出現 <、>、& 等字元,務必轉義為 <、>、&,否則瀏覽器會把它當成標籤解析,導致內容消失或版面跑掉。這也是為什麼範例中的 PHP 開關寫成 <?php。
第二,若程式碼是透過 AJAX 動態插入頁面,initHighlightingOnLoad 不會自動作用於新內容,此時要改用 hljs.highlightBlock(block) 針對指定元素手動呼叫,或重新執行一次 hljs.initHighlighting()。
更多關於 JavaScript 的相關內容,有興趣的讀者可延伸閱讀本站的《JavaScript 數據結構與算法技巧總結》、《JavaScript 切換特效與技巧總結》、《JavaScript 查找算法技巧總結》、《JavaScript 動畫特效與技巧匯總》、《JavaScript 錯誤與調試技巧總結》、《JavaScript 遍歷算法與技巧總結》及《JavaScript 數學運算用法總結》等專題。