Add in code examples

Author: tbranyen

index.html

@@ -115,7 +115,8 @@ <h3>API Documentation</h3>
                       </tr>
                     </tbody>
                   </table>
-                  <hr>
+                  <pre class="const language-javascript">
+<code>var {{ jsClassName }} = require("nodegit").{{ jsClassName }};</code></pre>
                   <div class="header">
                     <strong class="{%if not ignore%}is{%else%}not{%endif%} added">in API</strong>
                     <strong class="deps">Depends on: <a class="ref">Repository</a></strong>
@@ -155,6 +156,15 @@ <h4>Functions:</h4>
                     {%each functions as function%}
                     <li id="{{jsClassName}}/function/{{function.jsFunctionName}}">
                       <strong class="{%if not function.ignore%}is{%else%}not{%endif%} added">{{jsClassName}}#</strong><strong class="method">{{function.jsFunctionName}}</strong>
+{%if function.isConstructorMethod%}
+<pre class="function language-javascript"><code>{{ jsClassName }}.{{ function.jsFunctionName }}({%each function.args|realArgs as arg%}{{arg.name|addComma arg i}}{%endeach%});</code></pre>
+{%else%}
+<pre class="function language-javascript">
+<code>var {{ jsClassName|toCamelCase }} = new {{ jsClassName }}();
+{{ jsClassName|toCamelCase }}.{{ function.jsFunctionName }}({%each function.args|realArgs as arg%}{{arg.name|addComma arg i }}{%endeach%});
+</code></pre>
+{%endif%}
+
                       <p>{{{function.comment}}}</p>
                       <h4>Arguments:</h4>
                       <div class="arguments">

scripts/api.js

@@ -15,6 +15,28 @@
 
     var contentTemplate = combyne($(".api-content script").eq(1).html().trim());
 
+    contentTemplate.registerFilter("realArgs", function(args) {
+      return args.filter(function(arg) {
+        return !arg.isSelf && !arg.isReturn;
+      }).map(function(arg, val, all) {
+        arg.length = all.length;
+        return arg;
+      });
+    });
+
+    contentTemplate.registerFilter("addComma", function(value, arg, index) {
+      if (index === arg.length -1) {
+        return value;
+      }
+      else {
+        return value + ", ";
+      }
+    });
+
+    contentTemplate.registerFilter("toCamelCase", function(value) {
+      return value[0].toLowerCase() + value.slice(1);
+    });
+
     resp.forEach(function(ctor) {
       // Add nav entry.
       var anchor = $("<a href='#" + ctor.jsClassName + "'><li>" + ctor.jsClassName + "</li><ul class='subnav'></ul></a>").appendTo(scrollable);
@@ -32,6 +54,9 @@
       });
     });
 
+    // Highlight the new code blocks.
+    Prism.highlightAll();
+
     listApi.on("click", "a", function(ev) {
       listApi.find("a").removeClass("active");
       $(this).addClass("active");

styles/api.css

@@ -160,3 +160,18 @@ ul.api-contents table h3 {
 }
 
 .scrollable::-webkit-scrollbar { width: 0 !important }
+
+.api-contents pre.const {
+  border: 1px solid #DFDADA;
+  margin-right: -20px;
+  margin-top: 20px;
+  margin-bottom: 20px;
+}
+
+.api-contents pre.const code {
+  margin-left: 10px;
+}
+
+pre.function {
+  margin-left: 0px !important;
+}