DIV CSS 佈局教程網

用 SyntaxHighlighter 替網頁上的程式碼上色並顯示行號
編輯:JavaScript綜合知識     

技術部落格最常被問到的問題之一:文章裡那些彩色又帶行號的程式碼區塊是怎麼做的?答案幾乎都是同一套——SyntaxHighlighter。它的用法出乎意料地簡單:引入核心腳本、引入對應語言的 brush、引入樣式表,然後呼叫一次 all()。

完整範例

<!DOCTYPE html>
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Javascript 程式碼高亮顯示行號</title>

<!-- 核心腳本 -->
<script type="text/javascript" src="scripts/shCore.js"></script>
<!-- 各語言的 brush,這裡是 JavaScript -->
<script type="text/javascript" src="scripts/shBrushJScript.js"></script>
<!-- 樣式主題 -->
<link type="text/css" rel="stylesheet" href="styles/shCoreDefault.css" />

<script type="text/javascript">
SyntaxHighlighter.all();
</script>
</head>

<body style="background: white; font-family: Helvetica">
<h1>Javascript 程式碼高亮顯示行號</h1>

<pre class="brush: js;">
function KeleyiColor() {
  document.write('keleyi.com');
  return "hi!";
}
</pre>

</body>
</html>

三個關鍵角色

  • shCore.js:核心,負責掃描頁面並替換節點,不可省略。
  • shBrushXxx.js:語言 brush,決定「這種語言的關鍵字長什麼樣」。要顯示 Java 就用 shBrushJava.js,要顯示 XML/HTML 就用 shBrushXml.js,可以同時引入多個。
  • shCoreDefault.css:主題樣式,換掉這個檔案就能換配色。

使用上的眉角

class="brush: js;" 是觸發關鍵。語言別名要寫對,js、java、xml、css、python 都可以,寫錯就是不上色,而且不會報錯,很難 debug。另外 pre 裡的程式碼含 < > 時必須轉義成 &lt; &gt;,否則會被瀏覽器當成標籤吃掉。

現代替代方案

SyntaxHighlighter 的時代,網址常常直接指向 CDN 上的檔案。今天如果重做,Prism.js 與 highlight.js 都更輕、更快,用法也類似——highlight.js 甚至只要引入一支腳本再呼叫 initHighlightingOnLoad()。但如果你維護的是老站,理解上面這套結構仍然很有用,因為換主題、加語言本質上都是同一件事:換 CSS、換 brush。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved