使用方法

<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

參考资料

代码高亮 highlightjs 使用文档的更多相关文章

  1. 打开地图文件和shape文件代码加载Mxd文档

    代码加载Mxd文档 用代码添加Mxd文档,用到AxMapControl.LoadMxFile(sFilePath),我们只要将Mxd文档的路径传给这个方法即可 /// <summary>  ...

  2. Markdown: 用写代码的思维写文档

    作者:吴香伟 发表于 2014/08/07 版权声明:可以任意转载,转载时务必以超链接形式标明文章原始出处和作者信息以及版权声明 本文不讲解Markdown的语法规则,只关注它带来的好处以及我使用的方 ...

  3. 使用Sandcastle 基于代码注释生成接口文档

    一. 工具下载: 1. Sandcastle:Sandcastle是微软官方的文档生成工具,下载地址:http://www.codeplex.com/Sandcastle 2. SHFBGuidedI ...

  4. ASP.NET Web API根据代码注释生成Help文档

    使用Visual Studio新建一个ASP.NET Web API项目,直接运行,查看Help文档可以看到如下的API帮助说明 如何在Description中显示描述. 1. 打开Controlle ...

  5. C# 代码注释生成代码提示和帮助文档

    C#文档注释格式: /// <summary> /// function description /// </summary> /// <param name=" ...

  6. C# 基于NPOI+Office COM组件 实现20行代码在线预览文档(word,excel,pdf,txt,png)

    由于项目需要,需要一个在线预览office的功能,小编一开始使用的是微软提供的方法,简单快捷,但是不符合小编开发需求, 就另外用了:将文件转换成html文件然后预览html文件的方法.对微软提供的方法 ...

  7. MyEclipse保存文件时 自动格式化代码! 不包括文档注释

    设置不格式化 文档注释

  8. Jenkins代码自动部署相关文档

    环境 centos 7.0+ Java JDK 1.8+ jenkins 2.220 maven 3.0+ git 1.8+ 注意事项 一. linux 安装 JDK (jdk-8u201-linux ...

  9. 基于opencv的gpu与cpu对比程序,代码来自opencv的文档中

    原文链接: http://www.opencv.org.cn/opencvdoc/2.3.2/html/doc/tutorials/gpu/gpu-basics-similarity/gpu-basi ...

随机推荐

  1. IEEEXtreme 10.0 - Ellipse Art

    这是 meelo 原创的 IEEEXtreme极限编程大赛题解 Xtreme 10.0 - Ellipse Art 题目来源 第10届IEEE极限编程大赛 https://www.hackerrank ...

  2. centos7 时间同步

    yum -y install ntp systemctl enable ntpd systemctl start ntpd ntpdate -u cn.pool.ntp.org

  3. eclipse 创建 maven 项目时如何修改 web 的版本和 jdk 的版本

    eclipse 创建 maven 项目时如何修改 web 的版本和 jdk 的版本 在使用 eclipse 创建 maven 项目的时候,默认的 web.xml 的版本时 2.3,默认 jre 的版本 ...

  4. Mock(模拟后端接口数据)配合Vuex的使用

    1.下载Mock  cnpm install Mockjs -S 2.新建一个data.js存放新生成的mock文件 编辑mock  并导出 const Mock = require('mockjs' ...

  5. bWAPP练习--injection篇之HTML Injection - Reflected (POST)

    POST的和之前的GET的过程差不多,只是表单的提交方式不一样而已. low 我们在表单中填入一个超链接 <a href="http://www.cnblogs.com/ESHLkan ...

  6. python @classmethod 的使用场合

    python @classmethod 的使用场合 官方的说法: classmethod(function)中文说明:classmethod是用来指定一个类的方法为类方法,没有此参数指定的类的方法为实 ...

  7. Python正则模块

    re模块 import re # match # 从头开始匹配, 只匹配一次,就结束 a = re.match('\d+', '54:58天5488:8451') # 默认就是0个群组 print(a ...

  8. 【BZOJ 2916】 2916: [Poi1997]Monochromatic Triangles (容斥)

    2916: [Poi1997]Monochromatic Triangles Time Limit: 1 Sec  Memory Limit: 128 MBSubmit: 310  Solved: 1 ...

  9. 【BZOJ 4332】 4332: JSOI2012 分零食 (FFT+快速幂)

    4332: JSOI2012 分零食 Time Limit: 10 Sec  Memory Limit: 256 MBSubmit: 119  Solved: 66 Description 这里是欢乐 ...

  10. java 接口 继承 接口 抽象类 继承 实体类

    韩梦飞沙  韩亚飞  313134555@qq.com  yue31313  han_meng_fei_sha 接口 可以 继承 接口 抽象类 可以 实现 接口 抽象类 继承实体类 需要 实体类 有 ...