Package Exports

docpad-plugin-text

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docpad-plugin-text) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Text Plugin for DocPad

This plugin allows you to render variables within templateData using text elements

Install

docpad install text

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="md.eco">here is a random number: **<%- Math.random() %>**</t>'
}

Doing the following inside a document:

My creator's firstname is: <t>firstname</t>
My creator's lastname is: <t>lastname</t>
My creator's fullname is: <t>fullname</t>
The markdown example is: <t>markdownExample</t>
The markdown eco example is: <t>markdownEcoExample</t>

Will output:

My creator's firstname is: Benjamin
My creator's lastname is: Lupton
My creator's fullname is: Benjamin Lupton
The markdown example is: this is so <strong>awesome</strong>
The markdown eco example is: here is a random number: <strong>0.5123213213123</strong>

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.

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

docpad-plugin-text