docpad-plugin-highlightjs
v2.6.0
Published
Adds support for Highlight.js syntax highlighting to DocPad
Downloads
97
Maintainers
Readme
Highlight.js Plugin for DocPad
This plugin enables Highlight.js syntax highlighting for DocPad
Install
Install the Plugin
docpad install highlightjs
Download a Stylesheet
Available stylesheets are here. You can preview some of them here.
Usage
Example inputs are here and their corresponding outputs are here. For the general gist of things, the following will suffice:
HTML
Input
<h3>Coffescript - Lang tag</h3>
<pre><code class="lang-coffeescript">
if true
func = ->
alert "hello world"
func()
</code></pre>
Output
<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> = ->
alert <span class="string">"hello world"</span>
func()
</code></pre>
Markdown
Input
### Coffeescript with fenced code
``` coffeescript
if true
func = ->
alert 'hello world'
func()
```
Output
<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> = ->
alert <span class="string">'hello world'</span>
func()</code></pre>
Configure
Language Aliases
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.
plugins:
highlightjs:
aliases:
missinglanguage: 'alternativelanguage'
You can find a list of languages that are supported via the Highlight.js source tree.
Replacing Tabs
By default, we replace tabs with 4 spaces. This can be changed by changing the replaceTab
configuration option:
plugins:
highlightjs:
replaceTab: null # keep tabs
Transforms
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.
plugins:
highlightjs:
transforms: [
# Remove extra indentation from the code block
# Requires: http://balupton.com/project/bal-util
(source, language) ->
require('bal-util').removeIndentation(source) if language in ['bash','coffeescript']
# Replace "(C)" with "©"
(source) -> source.replace /\(C\)/gm, '©'
]
Class Name
You can customise the css classname that is added by adjusting the className
configuration option, defaults to highlight
plugins:
highlightjs:
className: 'blah'
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md 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:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under: