代码高亮 highlightjs 使用文档

浏览数：30 / 时间：2015年06月09日

用法

    <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