技術文章中貼程式碼,如果全部是一視同仁的單色文字,閱讀體驗會差很多。SyntaxHighlighter 是以 JavaScript 寫成的語法高亮工具,功能完整、支援語言多,只要幾行程式碼就能把 pre 區塊變成有行號、有色彩、可複製的程式碼框。
第一步,引入核心腳本:
<script type="text/javascript" src="syntaxhighlighter/scripts/shCore.js"></script>
第二步,載入對應語言的 brush 腳本。例如 JavaScript:
<script type="text/javascript" src="syntaxhighlighter/scripts/shBrushJScript.js"></script>
C# 則是:
<script type="text/javascript" src="syntaxhighlighter/scripts/shBrushCSharp.js"></script>
第三步,引入樣式表:
<link type="text/css" rel="stylesheet" href="syntaxhighlighter/styles/shCoreDefault.css" />
第四步,呼叫初始化:
<script type="text/javascript">SyntaxHighlighter.all();</script>
最後,把要上色的程式碼放進帶有 brush 別名的 pre 標籤裡:
<pre class="brush: js;">
var year = now.getFullYear();
var month = now.getMonth();
var date = now.getDate();
document.write("年月日:" + year + " " + month + " " + date);
</pre>
其中 brush:js 表示內容是 JavaScript,若是 C# 則寫成 brush:csharp。也能用 gutter:false 關掉行號欄。
| Brush name | Brush aliases | File name |
|---|---|---|
| ActionScript3 | as3, actionscript3 | shBrushAS3.js |
| Bash/shell | bash, shell | shBrushBash.js |
| ColdFusion | cf, coldfusion | shBrushColdFusion.js |
| C# | c-sharp, csharp | shBrushCSharp.js |
| C++ | cpp, c | shBrushCpp.js |
| CSS | css | shBrushCss.js |
| Delphi | delphi, pas, pascal | shBrushDelphi.js |
| Diff | diff, patch | shBrushDiff.js |
| Erlang | erl, erlang | shBrushErlang.js |
| Groovy | groovy | shBrushGroovy.js |
| JavaScript | js, jscript, javascript | shBrushJScript.js |
| Java | java | shBrushJava.js |
| JavaFX | jfx, javafx | shBrushJavaFX.js |
| Perl | perl, pl | shBrushPerl.js |
| PHP | php | shBrushPhp.js |
| Plain Text | plain, text | shBrushPlain.js |
| PowerShell | ps, powershell | shBrushPowerShell.js |
| Python | py, python | shBrushPython.js |
| Ruby | rails, ror, ruby | shBrushRuby.js |
| Scala | scala | shBrushScala.js |
| SQL | sql | shBrushSql.js |
| Visual Basic | vb, vbnet | shBrushVb.js |
| XML | xml, xhtml, xslt, html | shBrushXml.js |
由於高亮是透過 JavaScript 在頁面載入後才處理,若文章內容很多,建議只載入真正用到的語言 brush,核心腳本以外的檔案不必全部引入,可以省下不少請求。另外,貼在 pre 裡的程式碼若含有 < 或 >,記得轉義成 < 與 >,否則會被瀏覽器當成標籤解析。