Permalink
Browse files

docs

  • Loading branch information...
1 parent a862148 commit 62ba1b1c4da08998afc3b8a158dede605cd993bf @tkellen tkellen committed Oct 3, 2012
Showing with 58 additions and 0 deletions.
  1. 0 docs/examples.md
  2. +57 −0 docs/options.md
  3. +1 −0 docs/overview.md
View
No changes.
View
@@ -0,0 +1,57 @@
+##### files ```object```
+
+This defines what files this task will process and should contain key:value pairs.
+
+The key (destination) should be an unique filepath (supports [grunt.template](https://github.com/cowboy/grunt/blob/master/docs/api_template.md)) and the value (source) should be a filepath or an array of filepaths (supports [minimatch](https://github.com/isaacs/minimatch)).
+
+Note: Values are precompiled to the namespaced JST array in the order passed.
+
+##### options ```object```
+
+This controls how this task (and its helpers) operate and should contain key:value pairs, see options below.
+
+#### Options
+
+##### namespace ```string```
+
+The namespace in which the precompiled templates will be asssigned (default is JST). *Use dot notation (e.g. App.Templates) for nested namespaces.*
+
+Example:
+```js
+options: {
+ namespace: 'JST'
+}
+```
+
+##### processName ```function```
+
+This option accepts a function which takes one argument (the template filepath) and returns a string which will be used as the key for the precompiled template object. The example below stores all templates on the default JST namespace in capital letters.
+
+```js
+options: {
+ processName: function(filename) {
+ return filename.toUpperCase();
+ }
+}
+```
+
+##### templateSettings ```object```
+
+The settings passed to underscore when compiling templates.
+
+#### Config Examples
+
+```js
+jst: {
+ compile: {
+ options: {
+ templateSettings: {
+ interpolate : /\{\{(.+?)\}\}/g
+ }
+ },
+ files: {
+ "path/to/compiled/templates.js": ["path/to/source/**/*.html"]
+ }
+ }
+}
+```
View
@@ -0,0 +1 @@
+This task compiles Underscore compatible templates into functions that can be concatenated and minified with existing source files.

0 comments on commit 62ba1b1

Please sign in to comment.