Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Adds support for the Jade templating engine to DocPad.
CoffeeScript HTML
branch: master
Failed to load latest commit information.
src Fix loading of plugin settings from docpad configuration.
test Fix loading of plugin settings from docpad configuration.
.editorconfig Add .editorconfig (v1.3.18 from bevry/base)
.gitignore updated base files
.npmignore updated base files
.travis.yml
CONTRIBUTING.md updated base files
Cakefile updated base files
HISTORY.md Updated jade dependency from ~1.7.0 to ~1.9.2
LICENSE.md updated base files
README.md updated base files
coffeelint.json updated base files
package.json updated base files

README.md

Jade Plugin for DocPad

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Adds support for the Jade templating engine to DocPad

Convention: .anything.jade

Install

docpad install jade

Awareness

Before you get started with Jade, it is important to be aware of one thing. The majority of support questions that come through with DocPad, aren't actually DocPad issues, but Jade issues. People confusing the syntax, Jade doing it's own templating magic, things like that.

The DocPad team recommends you try one of the many other amazing templating engines that are available, over trying to use Jade.

If you still insist on using Jade, please be aware, Jade will be a slippery slope, but luckily there are determined Jade users here to help :)

Usage

Template Helpers as Filters

Use just like any jade template. However, we do add any docpad template helpers you may have as jade filters. There are two ways you can use these filters:

-# first way, calls the template helper like: myTemplateHelper("content", {opt1="blah",opt2="blah",opt3=true})
:myTemplateHelper(opt1=blah,opt2=blah,opt3)
    content

-# second way, calls the template helper like: myTemplateHelper(arg1, arg2)
:myTemplateHelper(args)
    arg1
    arg2

NOTE: Not all template helpers support being called this way. If it doesn't work, we'd recommend using the text plugin to render eco which includes your template helper call. See following section.

Rendering with the Text Plugin

You can use the text plugin to render different parts of your template with different markups that are support by your docpad setup. Once installed, you can do things like:

:t(render="markdown")
    here is some *markdown*

:t(render="html.md.eco")
    here is some <%-'eco'.toUpperCase()%> to *markdown* to html

:t(render="html.eco")
    my url is <%-@document.url%>

History

Discover the change 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?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Unless stated otherwise all works are:

and licensed under:

Something went wrong with that request. Please try again.