Text Plugin for DocPad
Allows you to render variables within templateData
using text elements
Usage
If you have this in your docpad.cson
templateData: firstname: 'Benjamin' lastname: 'Lupton' fullname: '<t>firstname</t> <t>lastname</t>' markdownExample: '<t render="markdown">this is so **awesome**</t>' markdownEcoExample: '<t render="html.md.eco">here is a random number: **<%- Math.random() %>**</t>'
Doing the following inside a document:
My creator's firstname is: firstname My creator's lastname is:lastname My creator's fullname is: fullname The markdown exampleis: markdownExample The markdown eco example is:markdownEcoExample
Will output:
My creator's firstname is: Benjamin My creator's lastname is: Lupton Mycreator's fullname is: Benjamin Lupton The markdown example is: this is soawesome The markdown eco example is: here is a random number:0.5123213213123
Which is incredibly useful for abstracting out common generic pieces of text from your templates and placing them inside your configuration files. A common use case for this is easy configurability of skeletons, as well as easier translation of your website.
If you are embedding a text block into a text block, it is best that you name your text block like so <t:myName>blah</t:myName>
that way our parser won't get confused as easily :)
To use it with coffeekup you'll do it like so tag 'text', {render:"md"}, "your **markdown** content"
. More info here..
Alternatively, you can use the t
template helper like so @t('*markdown*', {render:"markdown"})
Configuration
matchElementRegexString
defaults to 't(?:ext)?'
What regex string should we use to find text elements. The default value will find <t>
and <text>
elements. If you use SVG, you may want to change this just to t
to avoid conflicts with the text
element.
preferredElement
defualts to 't'
What element should be preferred when we are inject text elements with the t
template helper? The default value will inject <t>
elements.
Install
Install this DocPad plugin by entering docpad install text
into your terminal.
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
- Daniel Cohen — view contributions
- Jeff Barczewski — 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
and licensed under: