add examples to the description

hyewon330 · Aug 8, 2018 · 71b3a49 · 71b3a49
1 parent b4f1126
commit 71b3a49
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/src/index.js b/src/index.js
@@ -93,9 +93,23 @@ const highlight = false;
 
     Handlebars.registerHelper('desc', function(schema) {
         var description = schema.description;
+        var examples = schema.examples;
+
+        var text = "";
+
+        if( !description && !examples ) {
+            return "";
+        }
+
+        if ( description ) {
+            text = description
+        }
+
+        if ( examples && examples.length > 0 ) {
+            examples = [ " Examples: \n" ].concat(examples).join("\n\t");
+            text = text + examples;
+        }
 
-        if( !description ) return "";
-        var text = description;
         if(marked) {
             marked.setOptions({gfm: true, breaks: true})
             return new Handlebars.SafeString(marked(text));