Roots Client Templates
Note: This project is in early development, and versioning is a little different. Read this for more details.
- make sure you are in your roots project directory
npm install client-templates --save
app.coffeefile to include the extension, as such
ClientTemplates = require('client-templates') module.exports = extensions: [ClientTemplates( base: "templates/", # required pattern: "*.jade", # defaults to ** out: "js/templates.js" # defaults to js/templates.js )] # everything else...
The example provided in the installation section is the minimum required to get things going. In this case it will look for a folder called
templates at the root, and precompile any
.jade file in that folder, outputting all the templates to
js/templates.js in your public folder. Now let's look over the full range of available options.
This extension also exposes a view helper function (
client_templates) that when called will render the script into your templates automatically. Here's how it could be used in jade:
p here's my great view != client_templates() //- outputs <script src='js/templates.js'></script>
This will be the name your templates are exposed as. If you are using commonjs or amd, it will be the name of the module, if neither, it will be attached to
window as this name. Default is
A minimatch-compatible string pointing to one or more files to be precompiled.
Where you want to output your templates to in your
public folder (or whatever you have set
output to in the roots settings). Default is
false in addition to being precompiled, templates are compiled normally as html files. Default is
true, the precompiled templates are concatenated into a single file with helpers at the top, wrapped with a [umd] wrapper, and each template is exported on an object with they key being the name of the file (minus extension). If false, each template is exported with a umd wrapper as it's own file as expected, and the helper functions (required to render templates) are exported alone in a file with the name decided by what you pass as
out. Default is