blear.utils.code-highlight

1Introduction

2Example

var codeHighlight = require('blear.utils.code-highlight');


// 高亮某个元素下的所有 pre
codeHighlight.element(el);

// 高亮文本
codeHighlight.text(text, lang);

3Langs

默认只支持 clike、markup(html)、css、javascript 四种类型语言,其他更多语言需要手动添加。 内置语言有:

require('blear.utils.code-highlight/langs/bash.js');
require('blear.utils.code-highlight/langs/dart.js');
require('blear.utils.code-highlight/langs/docker.js');
require('blear.utils.code-highlight/langs/go.js');
require('blear.utils.code-highlight/langs/ini.js');
require('blear.utils.code-highlight/langs/java.js');
require('blear.utils.code-highlight/langs/json.js');
require('blear.utils.code-highlight/langs/jsx.js');
require('blear.utils.code-highlight/langs/less.js');
require('blear.utils.code-highlight/langs/lisp.js');
require('blear.utils.code-highlight/langs/lua.js');
require('blear.utils.code-highlight/langs/makefile.js');
require('blear.utils.code-highlight/langs/markdown.js');
require('blear.utils.code-highlight/langs/nginx.js');
require('blear.utils.code-highlight/langs/php.js');
require('blear.utils.code-highlight/langs/python.js');
require('blear.utils.code-highlight/langs/ruby.js');
require('blear.utils.code-highlight/langs/sass.js');
require('blear.utils.code-highlight/langs/scss.js');
require('blear.utils.code-highlight/langs/sql.js');
require('blear.utils.code-highlight/langs/stylus.js');
require('blear.utils.code-highlight/langs/swift.js');
require('blear.utils.code-highlight/langs/typescript.js');
require('blear.utils.code-highlight/langs/yaml.js');

4Themes

内置两种主题风格,light 和 dark。也需要手动引用。

require('blear.utils.code-highlight/themes/light.js');
require('blear.utils.code-highlight/themes/dark.js');

5Static

5.1.element([el]): undefined

高亮元素下的所有符合规范的 pre。

5.1.1el

  • 类型:Element
  • 说明:查找元素
  • 默认:body

5.2.text(text, lang, [wrap]): html

高亮元素下的所有符合规范的 pre。

5.2.1text

  • 类型:string
  • 说明:文本

5.2.2lang

  • 类型:string
  • 说明:语言,如果没有该语言,需要预先载入

5.2.3wrap

  • 类型:boolean
  • 说明:是否包装 <pre><code>
  • 默认:false

5.2.4html

  • 类型:string
  • 说明:高亮后的 html

6Dependencies

7Reference