DIV CSS 佈局教程網

用 JavaScript 在客戶端為代碼著色並顯示行號
編輯:關於JavaScript     

技術博客上貼代碼,如果只有等寬字體會很難讀。在客戶端做語法高亮有兩個好處:一是原文保持純文本,複製粘貼不帶雜質;二是換主題只需換一個 CSS 文件。原理是引入一個高亮庫,讓它掃描頁面中帶特定 class 的代碼塊並重寫其內部 HTML。

效果預覽

示例頁面:https://www.keleyi.com/keleyi/phtml/codecolor/a/index.htm

完整代碼

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Javascript 代碼高亮著色顯示行號</title>

<!-- 核心腳本與 JavaScript 語言規則 -->
<script type="text/javascript" src="scripts/shCore.js"></script>
<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 是規則包,CSS 則負責配色。
  • 著色的觸發靠 class="brush: js;",把 js 換成 java、css、xml、php 等即可對應不同語言,前提是引入相應的規則包。
  • SyntaxHighlighter.all() 通常在 head 中調用,它會在 DOM 就緒後自動處理所有代碼塊。
  • 行號、是否折行、顯示工具列等都可以通過 class 中的配置項控制,例如 class="brush: js; gutter: true;"。
  • 需要注意 <pre> 中的內容會被瀏覽器原樣解析,粘貼代碼時若包含 < 要手動轉義,否則會被當成標籤。

替代選擇

今天更主流的方案是 highlight.js 和 Prism.js:體積更小、語言支持更廣、自動語言檢測也更準。以 highlight.js 為例,引入 CSS 與 JS 後只需一行 hljs.highlightAll(),並給代碼塊加 <pre><code class="javascript"> 即可,行號需要額外插件或自行用 CSS 計數器實現。上面的 SyntaxHighlighter 方案在維護老站點時仍然常見。

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