You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 lines
4.8 KiB
61 lines
4.8 KiB
{
|
|
"name": "docpad-plugin-text",
|
|
"version": "2.2.4",
|
|
"description": "Allows you to render templateData with HTML elements",
|
|
"homepage": "http://docpad.org/plugin/text",
|
|
"keywords": [
|
|
"docpad",
|
|
"docpad-plugin",
|
|
"text",
|
|
"render",
|
|
"rendering",
|
|
"renderer",
|
|
"templating"
|
|
],
|
|
"author": {
|
|
"name": "Bevry Pty Ltd",
|
|
"email": "us@bevry.me",
|
|
"url": "http://bevry.me"
|
|
},
|
|
"maintainers": [
|
|
{
|
|
"name": "Benjamin Lupton",
|
|
"email": "b@lupton.cc",
|
|
"url": "https://github.com/balupton"
|
|
}
|
|
],
|
|
"contributors": [
|
|
{
|
|
"name": "Benjamin Lupton",
|
|
"email": "b@lupton.cc",
|
|
"url": "https://github.com/balupton"
|
|
}
|
|
],
|
|
"bugs": {
|
|
"url": "https://github.com/bevry/docpad-extras/issues"
|
|
},
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "http://github.com/bevry/docpad-extras.git"
|
|
},
|
|
"engines": {
|
|
"node": ">=0.4",
|
|
"docpad": ">=6.1 <7"
|
|
},
|
|
"dependencies": {
|
|
"bal-util": "~2.2.0",
|
|
"taskgroup": "~3.1.1"
|
|
},
|
|
"devDependencies": {
|
|
"coffee-script": "~1.6.2",
|
|
"docpad": ">=6.37 <7"
|
|
},
|
|
"main": "./out/text.plugin.js",
|
|
"scripts": {
|
|
"test": "node ./out/text.test.js"
|
|
},
|
|
"readme": "# Text Plugin for [DocPad](http://docpad.org)\n\n[](http://travis-ci.org/docpad/docpad-plugin-text \"Check this project's build status on TravisCI\")\n[](https://npmjs.org/package/docpad-plugin-text \"View this project on NPM\")\n[](http://flattr.com/thing/344188/balupton-on-Flattr \"Donate monthly to this project using Flattr\")\n[](https://www.paypal.com/au/cgi-bin/webscr?cmd=_flow&SESSION=IHj3DG3oy_N9A9ZDIUnPksOi59v0i-EWDTunfmDrmU38Tuohg_xQTx0xcjq&dispatch=5885d80a13c0db1f8e263663d3faee8d14f86393d55a810282b64afed84968ec \"Donate once-off to this project using Paypal\")\n\nThis plugin allows you to render variables within `templateData` using text elements\n\nE.g. if you have this in your `docpad.cson`\n\n``` coffeescript\n{\n\ttemplateData:\n\t\tfirstname: 'Benjamin'\n\t\tlastname: 'Lupton'\n\t\tfullname: '<t>firstname</t> <t>lastname</t>'\n\t\tmarkdownExample: '<t render=\"markdown\">this is so **awesome**</t>'\n\t\tmarkdownEcoExample: '<t render=\"md.eco\">here is a random number: **<%- Math.random() %>**</t>'\n}\n```\n\nDoing the following inside a document:\n\n``` html\nMy creator's firstname is: <t>firstname</t>\nMy creator's lastname is: <t>lastname</t>\nMy creator's fullname is: <t>fullname</t>\nThe markdown example is: <t>markdownExample</t>\nThe markdown eco example is: <t>markdownEcoExample</t>\n```\n\nWill output:\n\n``` html\nMy creator's firstname is: Benjamin\nMy creator's lastname is: Lupton\nMy creator's fullname is: Benjamin Lupton\nThe markdown example is: this is so <strong>awesome</strong>\nThe markdown eco example is: here is a random number: <strong>0.5123213213123</strong>\n```\n\nWhich 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.\n\nIf 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 :)\n\nTo use it with [coffeekup](http://coffeekup.org/) you'll do it like so `tag 'text', {render:\"md\"}, \"your **markdown** content\"`. [More info here.](https://github.com/bevry/docpad/issues/194#issuecomment-11363441).\n\nAlternatively, you can use the `t` template helper like so `@t('*markdown*', {render=\"markdown\"})`\n\n\n## Install\nTo use this plugin with DocPad, simply run `npm install docpad-plugin-text` inside your website's directory. You'd probably also want to add `\"docpad-plugin-text\": \"latest\"` to your `package.json` dependencies.\n\n\n## History\n[You can discover the history inside the `History.md` file](https://github.com/bevry/docpad-plugin-text/blob/master/History.md#files)\n\n\n## Contributing\n[You can discover the contributing instructions inside the `Contributing.md` file](https://github.com/bevry/docpad-plugin-text/blob/master/Contributing.md#files)\n\n\n## License\nLicensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)\n<br/>Copyright © 2012+ [Bevry Pty Ltd](http://bevry.me) <us@bevry.me>\n",
|
|
"readmeFilename": "README.md",
|
|
"_id": "docpad-plugin-text@2.2.4",
|
|
"_from": "docpad-plugin-text@2"
|
|
}
|