Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Cleaning up options documentation. Adding defaults and creating bette…

…r consistency.

Closes gh-20.
  • Loading branch information...
commit d7f6b6beecc770847d1282bb4408b60c412477cf 1 parent a56e2f5
gvn lazar suntop authored tkellen committed

Showing 1 changed file with 17 additions and 17 deletions. Show diff stats Hide diff stats

  1. 34  docs/jade-options.md
34  docs/jade-options.md
Source Rendered
@@ -2,42 +2,39 @@
2 2
 
3 3
 ## pretty
4 4
 Type: `Boolean`
5  
-Default: false
  5
+Default: **false**
6 6
 
7 7
 Output indented HTML.
8 8
 
9 9
 ## data
10 10
 Type: `Object`
11 11
 
12  
-Sets the data passed to `jade` during template compilation. Any data can be passed to the template (including `grunt` templates).
  12
+Sets the data passed to Jade during template compilation. Any data can be passed to the template (including grunt templates).
13 13
 
14 14
 ## compileDebug
15 15
 Type: `Boolean`
  16
+Default: **true**
16 17
 
17  
-Set `compileDebug: fase` to remove `jade` debug instructions in javascript templates.
  18
+Add Jade debug instructions to generated JS templates.
18 19
 
19 20
 ## client
20 21
 Type: `Boolean`
21  
-Default: `false`
  22
+Default: **false**
22 23
 
23 24
 Compile to JS template functions for client-side use rather than directly to HTML.
24 25
 
25 26
 ## namespace
26  
-Type: `String` `false`
27  
-Default: 'JST'
  27
+Type: `String`, `Boolean`
  28
+Default: **JST**
28 29
 
29  
-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.
  30
+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.
  31
+
  32
+When set to `false` with **amd** option set to `true`, the templates will be returned directly from the AMD wrapper.
30 33
 
31  
-Example:
32  
-```js
33  
-options: {
34  
-  namespace: 'MyApp.Templates'
35  
-}
36  
-```
37 34
 
38 35
 ## amd
39 36
 Type: `Boolean`
40  
-default: `false`
  37
+Default: **false**
41 38
 
42 39
 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.
43 40
 
@@ -49,9 +46,12 @@ define(function() {
49 46
 ```
50 47
 
51 48
 ## processName
52  
-Type: `function`
  49
+Type: `Function`
  50
+
  51
+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.
53 52
 
54  
-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.
  53
+**Example**
  54
+Store all template on the default JST namespace in capital letters.
55 55
 
56 56
 ```js
57 57
 options: {
@@ -59,4 +59,4 @@ options: {
59 59
     return filename.toUpperCase();
60 60
   }
61 61
 }
62  
-```
  62
+```

0 notes on commit d7f6b6b

Please sign in to comment.
Something went wrong with that request. Please try again.