Jade Plugin for DocPad
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)arg1arg2
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.
Jade :filters
Since 1.10.0 Jade supports jstransformers, which allows improved handling of embedded languages such as Coffee-Script, and deprecated Transformers support in filters - to be removed in 2.0.0.
All JSTransformers can now be used as jade filters.
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 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?
Contributors
These amazing people have contributed code to this project:
- Benjamin Lupton — view contributions
- Evan Bovie — view contributions
- Roman Komarov — view contributions
- Tobias Birmili — view contributions
- Vladislav Botvin — view contributions
- Roman Piták — view contributions
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
License
Unless stated otherwise all works are:
- Copyright © 2012+ Bevry Pty Ltd
- Copyright © 2011 Benjamin Lupton
and licensed under: