cartodb/grunt-contrib-jst
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Tyler Kellen 2013-03-06 12:54:06 -05:00
parent 4eaee630c9
commit 0588336f6c
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -41,7 +41,7 @@ Concatenated files will be joined on this string.
Type: `String` Type: `String`
Default: 'JST' Default: 'JST'
The namespace in which the precompiled templates will be asssigned. *Use dot notation (e.g. App.Templates) for nested namespaces.* The namespace in which the precompiled templates will be assigned. Use dot notation (e.g. App.Templates) for nested namespaces or false for no namespace wrapping. When false with amd option set true, templates will be returned directly from the AMD wrapper.
#### processName #### processName
Type: `function` Type: `function`
@ -92,24 +92,23 @@ options: {
} }
``` ```
#### amdWrapper #### amd
Type: `boolean` Type: `boolean`
Default: false Default: false
With Require.js and a pre-compiled template.js you want the templates to be Wraps the output file with an AMD define function and returns the compiled template namespace unless namespace has been explicitly set to false in which case the template function will be returned directly.
wrapped in a define. This will wrap the output in:
```js ```js
define(function() { define(function() {
//Templates //...//
return this["NAMESPACE"]; returns this['[template namespace]'];
}); });
``` ```
Example: Example:
```js ```js
options: { options: {
amdWrapper: true amd: true
} }
``` ```
@ -164,4 +163,4 @@ jst: {
Task submitted by [Tim Branyen](http://tbranyen.com) Task submitted by [Tim Branyen](http://tbranyen.com)
*This file was generated on Wed Mar 06 2013 12:51:11.* *This file was generated on Wed Mar 06 2013 12:53:43.*

13
docs/jst-options.md
View File

@ -10,7 +10,7 @@ Concatenated files will be joined on this string.
Type: `String` Type: `String`
Default: 'JST' Default: 'JST'
The namespace in which the precompiled templates will be asssigned. *Use dot notation (e.g. App.Templates) for nested namespaces.* The namespace in which the precompiled templates will be assigned. Use dot notation (e.g. App.Templates) for nested namespaces or false for no namespace wrapping. When false with amd option set true, templates will be returned directly from the AMD wrapper.
## processName ## processName
Type: `function` Type: `function`
@ -61,24 +61,23 @@ options: {
} }
``` ```
## amdWrapper ## amd
Type: `boolean` Type: `boolean`
Default: false Default: false
With Require.js and a pre-compiled template.js you want the templates to be Wraps the output file with an AMD define function and returns the compiled template namespace unless namespace has been explicitly set to false in which case the template function will be returned directly.
wrapped in a define. This will wrap the output in:
```js ```js
define(function() { define(function() {
//Templates //...//
return this["NAMESPACE"]; returns this['[template namespace]'];
}); });
``` ```
Example: Example:
```js ```js
options: { options: {
amdWrapper: true amd: true
} }
``` ```