diff --git a/docs/jst-options.md b/docs/jst-options.md index f4ea625..f6a3e8a 100644 --- a/docs/jst-options.md +++ b/docs/jst-options.md @@ -1,20 +1,20 @@ # Options ## separator -Type: `String` +Type: `String` Default: linefeed + linefeed Concatenated files will be joined on this string. ## namespace -Type: `String` -Default: 'JST' +Type: `String` +Default: `'JST'` 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 -Type: `function` -Default: null +Type: `function` +Default: `null` 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. @@ -27,8 +27,8 @@ options: { ``` ## templateSettings -Type: `Object` -Default: null +Type: `Object` +Default: `null` The settings passed to underscore when compiling templates. @@ -48,8 +48,8 @@ jst: { ``` ## prettify -Type: `boolean` -Default: false +Type: `boolean` +Default: `false` When doing a quick once-over of your compiled template file, it's nice to see an easy-to-read format that has one line per template. This will accomplish @@ -62,8 +62,8 @@ options: { ``` ## amd -Type: `boolean` -Default: false +Type: `boolean` +Default: `false` 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.