Adds support for Highlight.js syntax highlighting to DocPad

Highlight.js Plugin for DocPad

This plugin enables Highlight.js syntax highlighting for DocPad

docpad install highlightjs

Available stylesheets are here. You can preview some of them here.

Example inputs are here and their corresponding outputs are here. For the general gist of things, the following will suffice:

<h3>Coffescript - Lang tag</h3>
<pre><code class="lang-coffeescript">
if true
    func = -&gt;
        alert "hello world"
<h3>Coffescript - Lang tag</h3>
<pre class="highlighted"><code class="coffeescript">
<span class="keyword">if</span> <span class="literal">true</span>
    <span class="function"><span class="title">func</span></span> = -&gt;
        alert <span class="string">"hello world"</span>
### Coffeescript with fenced code

``` coffeescript
if true
    func = ->
        alert 'hello world'
<h3>Coffeescript with fenced code</h3>
<pre class="highlighted"><code class="coffeescript"><span class="keyword">if</span> <span class="literal">true</span>
    <span class="function"><span class="title">func</span></span> = -&gt;
        alert <span class="string">'hello world'</span>

Sometimes one of the languages you want to highlight isn't available. In which case, you'd probably want to add an alias for it to a language that is similar. To do this, you'll want to add something like the following to your docpad configuration file.

            missinglanguage: 'alternativelanguage'

You can find a list of languages that are supported via the Highlight.js source tree.

By default, we replace tabs with 4 spaces. This can be changed by changing the replaceTab configuration option:

        replaceTab: null  # keep tabs 

You can apply transformations to code blocks before they are highlighted by using the transforms configuration option. It accepts an array of functions or arrays.

        transforms: [
            # Remove extra indentation from the code block 
            # Requires: 
            (source, language) ->
                require('bal-util').removeIndentation(source)  if language in ['bash','coffeescript']
            # Replace "(C)" with "&copy;" 
            (source) -> source.replace /\(C\)/gm'&copy;'

You can customise the css classname that is added by adjusting the className configuration option, defaults to highlight

        className: 'blah'

Discover the change history by heading on over to the file.

Discover how you can contribute by heading on over to the file.

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

Become a contributor!

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Chase Colman (