‚̧Neverending Pun Machine
    Have ideas to improve npm?Join in the discussion! ¬Ľ

    docpad-plugin-highlightjs

    2.6.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    Highlight.js Plugin for DocPad

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
    Slack community badge

    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 = -&gt;
            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> = -&gt;
            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> = -&gt;
            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 "&copy;" 
                (source) -> source.replace /\(C\)/gm, '&copy;'
            ]

    Class Name

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

    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:

    Sponsors

    No sponsors yet! Will you be the first?

    Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

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

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i docpad-plugin-highlightjs

    DownloadsWeekly Downloads

    29

    Version

    2.6.0

    License

    MIT

    Unpacked Size

    42.3 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar