代碼高亮 highlightjs 使用文檔

使用方法

  
  
  
  

   
   
   
   
  
   
   
   
   
   
  
   
  
  
  
  
 <link rel="stylesheet" href="../../assets/highlight/styles/default.css"> <script type="text/javascript" charset="UTF-8" src="../../assets/highlight/highlight.pack.js"></script>

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

參考資料

• http://highlightjs.readthedocs.org/en/latest/api.html