Module: highlight

Methods

(inner) highlight(str, optsopt) → {String}

Highlight a str.

Parameters:
Name Type Attributes Description
str String
opts Object <optional>

Optional hljs parameters.

Properties
Name Type Attributes Description
hljs Boolean <optional>

Add hljs- prefix to class name.

gutter Boolean <optional>

Generate line numbers.

Source:
Returns:

Highlighted HTML.

Type
String

Type Definitions

Data

Type:
  • Object
Properties:
Name Type Attributes Description
relevance Number <optional>
language String <optional>

Detected language.

value String

Highlighted HTML string.

Source: