用法

API

暴露出來的方法都放在hljs物件中

• highlight(name, value, ignore_illegals, continuation)
  用指定的語言高亮程式碼塊
  引數： name：語言名稱 value：原始HTML
  字串 ignore_illegals：是否忽略非法字元 continuation：是否繼續未完成的解析

返回值：Object
language: 指定的語言，和輸入的一致
relevance: 整數值
value: 處理後的高麗HTML字串
top: top of the current mode stack

• highlightAuto(value, languageSubset)
  自動高亮指定語言中的程式碼塊
  引數： value：html標籤 languageSubset：語言陣列 返回值：Object language:檢測到的語言 relevance:整數值 value
  :被高亮的HTML標記 second_best:檢車到的第二語言，有可能為空

• fixMarkup(value)
  後處理高亮的標記，比如替換TAB，<br>等，配置項是在configure中設定的

• highlightBlock(block)
  應用高亮到一個包含程式碼的DOM節點上

• configure(options)
  全域性配置
  tabReplace: 用來替換TAB字串的字元
  useBR: 一個開關選項，用來生成<br>代替新一行的字元，當代碼使用非<pre>包裹時很有用
  classPrefix: 一個載入類名前面的字串標記，為了相容樣式表
  languages: 語言名稱或別名的陣列，對於這些語言使用自動檢測

  hljs.configure({ tabReplace:' ',// 4 spaces classPrefix:''// don't append class prefix// … other options aren't changed}) hljs.initHighlighting();

• initHighlighting()
  在頁面的<pre><code>..</code></pre>區域上應用高亮

• initHighlightingOnLoad()
  繫結高亮到頁面載入事件上

• registerLanguage(name, language)
  增加一種支援語言，絕大部分情況下內部使用
  name：被支援語言的名稱
  language支援語言的函式

• listLanguages()
  返回語言名稱列表

• getLanguage(name)
  通過名稱或者匿名查詢語言，返回一個object物件，否則返回null

參考資料