1.4.0: if an example's type is explicitly set to 'string' then don't syntax highlight it

Kevin Renskers · Kevin Renskers · commit dfad7b8ef1a0 · 2015-01-30T20:11:32.000Z
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,6 @@
+1.4.0 - January 30, 2015
+- If an example's type is explicitly set to 'string' then don't syntax highlight it
+
 1.3.1 - January 28, 2015
 - Fixed the id's of the tabs (#108)
 
diff --git a/examples/example.html b/examples/example.html
diff --git a/examples/example.raml b/examples/example.raml
@@ -224,6 +224,12 @@ traits:
   get:
     is: [ paged ]
     description: Get a list of all users
+    queryParameters:
+      from:
+        description: Limit results to those created after from.
+        example: '2014-12-31T00:00:00.000Z'
+        type: string
+        required: false
 
   post:
     description: Creates a new user
diff --git a/lib/item.handlebars b/lib/item.handlebars
@@ -23,6 +23,10 @@
 
     {{#if this.example}}
         <p><strong>Example</strong>:</p>
-        <pre><code>{{this.example}}</code></pre>
+        {{#ifTypeIsString}}
+            <pre>{{this.example}}</pre>
+        {{else}}
+            <pre><code>{{this.example}}</code></pre>
+        {{/ifTypeIsString}}
     {{/if}}
 </li>
diff --git a/lib/raml2html.js b/lib/raml2html.js
@@ -51,6 +51,14 @@ function _emptyRequestCheckHelper(options) {
     }
 }
 
+function _ifTypeIsString(options) {
+    if (this.type && this.type === 'string') {
+        return options.fn(this)
+    } else {
+        return options.inverse(this);
+    }
+}
+
 /*
  The config object can contain the following keys and values:
  template: string or Handlebars object containing the main template (required)
@@ -114,7 +122,8 @@ function getDefaultConfig(https, mainTemplate, resourceTemplate, itemTemplate) {
             emptyResourceCheck: _emptyResourceCheckHelper,
             emptyRequestCheckHelper: _emptyRequestCheckHelper,
             md: _markDownHelper,
-            lock: _lockIconHelper
+            lock: _lockIconHelper,
+            ifTypeIsString: _ifTypeIsString
         },
         partials: {
             resource: resourceTemplate,
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "raml2html",
   "description": "RAML to HTML documentation generator",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": {
     "name": "Kevin Renskers",
     "email": "info@mixedcase.nl"

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "raml2html",`
`3`	`3`	`"description": "RAML to HTML documentation generator",`
`4`		`- "version": "1.3.1",`
	`4`	`+ "version": "1.4.0",`
`5`	`5`	`"author": {`
`6`	`6`	`"name": "Kevin Renskers",`
`7`	`7`	`"email": "[email protected]"`