使用方法

<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. CentOS7.5安装Mysql5.7.22

    一 下载 下载地址:https://www.mysql.com/downloads/ 1 点击第一个链接地址,进入MySQL官方网站,单击“Downloads”下载Tab页,进入下载界面 2 找到Co ...

  2. 为什么可以这么快! awk 与python的应用

    这几天刚处理一个排序问题 源文件: 可以看到有11G大小,需要根据最后一列的热度来做一下排序.如果让你来做这样的排序,在linux环境下,你会如何处理呢? xch27@lanzhou:/asrdata ...

  3. bzoj 1101 莫比乌斯反演

    最裸的莫比乌斯 #include<bits/stdc++.h> #define LL long long #define fi first #define se second #defin ...

  4. linux网络管理----网络命令

    1 Linux网络命令之网络环境查看命令  ifconfig  2 Linux网络命令之网络测试命令  telnet 基本已经被ssh替代了,telnet是明文传递,不安全

  5. TopTicTacToe 开发文档

    团队成员: 1.张旭 2.余浩 3.孙闯 4.吴阳 5.王晓华 6.张国庆 开发文档地址:http://www.kancloud.cn/netcon/t4 代码项目地址:https://coding. ...

  6. python 2 如何安装 MySQL 数据库操作库

    我试了好几种网上的办法,在 windows 10 VS2017 环境下不是缺了头文件,就是缺 .lib,反正十分繁琐,以后我也懒得搞了,都用 annaconda 来搞定就好了,时间宝贵. 在 控制台中 ...

  7. Python并发编程-信号量

    信号量保证同一资源同一时间只能有限定的进程去访问 一套资源,同一时间,只能被n个人访问 某一段代码,同一时间,只能被n个进程执行 from multiprocessing import Process ...

  8. 关于字体剥离和精简工具 FontSubsetGUI 和 FontPruner 的比较。

    在 Unity 中制作游戏时对动态字体的剥离和精简是现在常用的手段,现在有两篇博客是大家阅读和参照较多的,分别是 如何精简Unity中使用的字体文件 和 FontPruner 字体精简工具.他们各自提 ...

  9. linux-ARM的几个使用指令

    1.u-boot.bin arm-linux-gnueabi-objdump -D -b binary -m arm u-boot.bin > u-boot.s arm-linux-gnueab ...

  10. XamarinForms教程构建XamarinForms开发环境

    构建XamarinForms开发环境 所谓Xamarin.Forms的开发环境,就是指在基本硬件和数字软件的基础上,为支持系统软件和应用软件的工程化开发和维护而使用的一组软件,简称SDE.对于任何的程 ...