hljs plugin for Dotclear 2

Packaging highlight.js script from Ivan Sagalaev and contributors

Usage

The plugin should be activated for the blog before using it.

Using HLJS in content

In order to specify codes to be rendered by HLJS you have to use the following syntax:

In Wiki mode:

///hljs [language_code]
...
///

Or this, if generic code compatibility mode is enabled (true by default)

///code [language_code]
...
///

In HTML (source) or Markdown modes:

<pre><code [class="language-{language_code}"]>
...
</code></pre>

In Markdown mode:

```language-{language_code}
...

Replacing `language_code` by one of the available syntaxes (see below)

!!! tip
Note that the plugin may **automatically** detect the language used in your code. In this case **do not specify** any language-code.

Exemple with this Javascript code:

```js hl_lines="1"
///hljs js
function findSequence(goal) {
    function find(start, history) {
        if (start == goal) return history;
        else if (start > goal) return null;
        else return find(start + 5, '(' + history + ' + 5)') || find(start * 3, '(' + history + ' * 3)');
    }
    return find(1, '1');
}
///

Available syntaxes

Min, Std and Com columns design respectively the Minimum, Standard and Commun Language Sets

YASH compatibility

the ///yash language_code wiki macro is supported by HLJS for the following syntaxes if enabled in the settings. See below the corresponding HLJS language code used regarding on YASH one.

YASH Syntaxes supported

Note: If not specified, HLJS will try to automatically detect the syntax used.

SyntaxeHL compatibility

the ///[language_code] wiki macro is supported by HLJS for the following syntaxes if enabled in the settings. See below the corresponding HLJS language code used regarding on SyntaxeHL one.

As SyntaxeHL worked differently than HLJS[^1], only further edition of existing posts and pages will be treated by HLJS.

[^1]: SyntaxeHL is a PHP library and then render code in content juste before it will be saved on the server database. HLJS will only be run when the code will be displayed, in the client's browser.

SyntaxeHL Syntaxes supported

Note: If not specified, the plain HLJS language code will be used.

References

• highlight.js API
• highlight.js demo
• highlight.js Github repository