# [Highlight.js](https://github.com/isagalaev/highlight.js) Plugin for [DocPad](http://docpad.org)

This plugin enables [Highlight.js](https://github.com/isagalaev/highlight.js) syntax highlighting for [DocPad](https://docpad.org) ## Install ### Install the Plugin ``` docpad install highlightjs ``` ### Download a Stylesheet [Available stylesheets are here.](https://github.com/isagalaev/highlight.js/tree/8.0/src/styles) [You can preview some of them here.](http://highlightjs.org/static/test.html) ## Usage Example inputs are [here](https://github.com/docpad/docpad-plugin-highlightjs/tree/master/test/src/documents) and their corresponding outputs are [here](https://github.com/docpad/docpad-plugin-highlightjs/tree/master/test/out-expected). For the general gist of things, the following will suffice: ### HTML #### Input ``` html

Coffescript - Lang tag


if true
	func = ->
		alert "hello world"

	func()

``` #### Output ``` html

Coffescript - Lang tag


if true
	func = ->
		alert "hello world"

	func()

``` ### Markdown #### Input ### Coffeescript with fenced code ``` coffeescript if true func = -> alert 'hello world' func() ``` #### Output ``` html

Coffeescript with fenced code

if true
	func = ->
		alert 'hello world'
	func()

``` ## 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. ``` coffee plugins: highlightjs: aliases: missinglanguage: 'alternativelanguage' ``` [You can find a list of languages that are supported via the Highlight.js source tree.](https://github.com/isagalaev/highlight.js/tree/master/src/languages) ### Replacing Tabs By default, we replace tabs with 4 spaces. This can be changed by changing the `replaceTab` configuration option: ``` coffee 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. ``` coffee 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` ``` coffee plugins: highlightjs: className: 'blah' ```