Highlight.js Plugin for DocPad

This plugin enables Highlight.js syntax highlighting for DocPad

Install

$3

``docpad install highlightjs`

`$3`

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:

`$3`

#### Input

`html

`Coffescript - Lang tag`



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


#### Output

`html

`Coffescript - Lang tag`



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


$3
#### 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
$3

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.

`$3`


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`

`$3`

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, '©' ]`

`$3`

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

`coffee plugins: highlightjs: className: 'blah'``

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

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

Backers

Maintainers

These amazing people are maintaining this project:

Chase Colman — view contributions

Benjamin Lupton — view contributions

Contributors

These amazing people have contributed code to this project:

Chase Colman — view contributions

Benjamin Lupton — view contributions

Bruno Heridet — view contributions

Mathias Bynens — view contributions

Rob Loach — view contributions

Troy Kershaw — view contributions

vsopvsop — view contributions

Merrick Christensen — view contributions

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

License

Unless stated otherwise all works are:

and licensed under:

MIT License

Highlight.js Plugin for DocPad

This plugin enables Highlight.js syntax highlighting for DocPad

Install

$3

``docpad install highlightjs`

`$3`

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:

`$3`

#### Input

`html

`Coffescript - Lang tag`



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


#### Output

`html

`Coffescript - Lang tag`



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


$3
#### 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
$3

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.

`$3`


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`

`$3`

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.