Style guides index

Author: orderedlist

_layouts/guides.html

@@ -0,0 +1,12 @@
+---
+layout: full
+---
+
+{% assign sections = page.content|split:'***' %}
+<div class="guides">
+{% for section in sections %}
+  <div class="document">
+    {{ section | markdownify }}
+  </div>
+{% endfor %}
+</div>

_sass/_layout.scss

@@ -224,6 +224,13 @@ header {
 
     ul {
       border:none;
+      list-style:none;
+
+      li {
+        padding:0;
+        background:none;
+        margin:0;
+      }
     }
   }
 
@@ -258,6 +265,64 @@ header {
       }
     }
   }
+
+  ul {
+    list-style:disc;
+
+    li {
+      margin:0 0 8px;
+      padding:0 0 0 25px;
+      background-image:url(/img/nodegit-mark.svg);
+      background-repeat:no-repeat;
+      background-size:16px;
+      background-position:0 5px;
+    }
+  }
+
+  .guides {
+    padding:0;
+    margin:0;
+
+    .document {
+      width:30%;
+      float:left;
+      box-sizing:border-box;
+      position:relative;
+      margin:0 5% 30px 0;
+
+      h2 {
+        padding-bottom:8px;
+        border-bottom:1px solid #ededed;
+
+        a {
+          color:#222;
+        }
+      }
+
+      blockquote {
+        border:none;
+        margin:-10px 0 0;
+        padding:0;
+        color:#999;
+      }
+
+      ul {
+        list-style:none;
+
+        li {
+          margin-left:0;
+        }
+      }
+
+      &:nth-child(3n) {
+        margin-right:0;
+      }
+
+      &:nth-child(3n+1) {
+        clear:left;
+      }
+    }
+  }
 }
 
 span.tags {
@@ -405,6 +470,29 @@ table {
     .outline {
       display:none;
     }
+
+    .guides {
+      .document {
+        width:45%;
+
+        &:nth-child(3n+1) {
+          clear:none;
+        }
+
+        &:nth-child(3n) {
+          clear:none;
+          margin-right:5%;
+        }
+
+        &:nth-child(2n+1) {
+          clear:left;
+        }
+
+        &:nth-child(2n) {
+          margin-right:0;
+        }
+      }
+    }
   }
 }
 
@@ -489,4 +577,14 @@ table {
       }
     }
   }
+
+  .page-content {
+    .guides {
+      .document {
+        float:none;
+        width:100%;
+        margin:0 0 30px;
+      }
+    }
+  }
 }

api/diff/index.md

@@ -12,6 +12,7 @@ sections:
   "treeToTree": "#treeToTree"
   "treeToWorkdir": "#treeToWorkdir"
   "treeToWorkdirWithIndex": "#treeToWorkdirWithIndex"
+  "#findSimilar": "#findSimilar"
   "#getDelta": "#getDelta"
   "#getPerfdata": "#getPerfdata"
   "#numDeltas": "#numDeltas"
@@ -118,6 +119,22 @@ Diff.treeToWorkdirWithIndex(repo, old_tree, opts).then(function(diff) {
 | --- | --- |
 | [Diff](/api/diff/) |  |
 
+## <a name="findSimilar"></a><span>Diff#</span>findSimilar <span class="tags"><span class="async">Async</span></span>
+
+```js
+diff.findSimilar(options).then(function(result) {
+  // Use result
+});
+```
+
+| Parameters | Type |
+| --- | --- | --- |
+| options | [DiffFindOptions](/api/diff_find_options/) | Control how detection should be run, NULL for defaults |
+
+| Returns |  |
+| --- | --- |
+| Number |  0 on success, -1 on failure |
+
 ## <a name="getDelta"></a><span>Diff#</span>getDelta <span class="tags"><span class="sync">Sync</span></span>
 
 ```js

api/diff_find_options/index.md

@@ -0,0 +1,28 @@
+---
+layout: default
+menu_item: api
+title: DiffFindOptions
+description: Version 0.3.0
+menu_item: api
+return_to:
+  "API Documentation Index": /api/
+sections:
+  "Instance Variables": "#ivars"
+---
+
+```js
+var diffFindOptions = new DiffFindOptions();
+```
+
+## <a name="ivars"></a>Instance Variables
+
+| Variable | Type |
+| --- | --- |
+| <a name="breakRewriteThreshold"></a>breakRewriteThreshold | Number |
+| <a name="copyThreshold"></a>copyThreshold | Number |
+| <a name="flags"></a>flags | Number |
+| <a name="renameFromRewriteThreshold"></a>renameFromRewriteThreshold | Number |
+| <a name="renameLimit"></a>renameLimit | Number |
+| <a name="renameThreshold"></a>renameThreshold | Number |
+| <a name="version"></a>version | Number |
+

api/index.md

@@ -36,6 +36,7 @@ sections:
   "Diff": "#Diff"
   "DiffDelta": "#DiffDelta"
   "DiffFile": "#DiffFile"
+  "DiffFindOptions": "#DiffFindOptions"
   "DiffHunk": "#DiffHunk"
   "DiffLine": "#DiffLine"
   "DiffOptions": "#DiffOptions"
@@ -522,6 +523,7 @@ sections:
 
 | Instance Methods |  |
 | --- | ---: |
+| [<span>Diff#</span>findSimilar <span>(options)</span>](/api/diff/#findSimilar) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Diff#</span>getDelta <span>(idx)</span>](/api/diff/#getDelta) |  <span class="tags"><span class="sync">Sync</span></span> |
 | [<span>Diff#</span>getPerfdata <span>()</span>](/api/diff/#getPerfdata) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Diff#</span>numDeltas <span>()</span>](/api/diff/#numDeltas) |  <span class="tags"><span class="sync">Sync</span></span> |
@@ -562,6 +564,19 @@ sections:
 | [<span>DiffFile#</span>size](/api/diff_file/#size) |  |
 
 
+## <a name='DiffFindOptions'></a>[DiffFindOptions](/api/diff_find_options/)
+
+| Instance Variables |  |
+| --- | ---: |
+| [<span>DiffFindOptions#</span>breakRewriteThreshold](/api/diff_find_options/#breakRewriteThreshold) |  |
+| [<span>DiffFindOptions#</span>copyThreshold](/api/diff_find_options/#copyThreshold) |  |
+| [<span>DiffFindOptions#</span>flags](/api/diff_find_options/#flags) |  |
+| [<span>DiffFindOptions#</span>renameFromRewriteThreshold](/api/diff_find_options/#renameFromRewriteThreshold) |  |
+| [<span>DiffFindOptions#</span>renameLimit](/api/diff_find_options/#renameLimit) |  |
+| [<span>DiffFindOptions#</span>renameThreshold](/api/diff_find_options/#renameThreshold) |  |
+| [<span>DiffFindOptions#</span>version](/api/diff_find_options/#version) |  |
+
+
 ## <a name='DiffHunk'></a>[DiffHunk](/api/diff_hunk/)
 
 | Instance Variables |  |
@@ -1209,6 +1224,7 @@ sections:
 | [<span>Remote.</span>isValidName <span>(remote_name)</span>](/api/remote/#isValidName) |  <span class="tags"><span class="sync">Sync</span></span> |
 | [<span>Remote.</span>list <span>(repo)</span>](/api/remote/#list) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Remote.</span>lookup <span>(repo, name, callback)</span>](/api/remote/#lookup) |  <span class="tags"><span class="async">Async</span></span> |
+| [<span>Remote.</span>push <span>(refSpecs, options, signature, message)</span>](/api/remote/#push) |  <span class="tags"><span class="async">Async</span></span> |
 
 | Instance Methods |  |
 | --- | ---: |
@@ -1279,7 +1295,10 @@ sections:
 | --- | ---: |
 | [<span>Repository#</span>config <span>()</span>](/api/repository/#config) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>configSnapshot <span>()</span>](/api/repository/#configSnapshot) |  <span class="tags"><span class="async">Async</span></span> |
+| [<span>Repository#</span>createLightweightTag <span>(String, name)</span>](/api/repository/#createLightweightTag) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>createRevWalk <span>(String)</span>](/api/repository/#createRevWalk) |  <span class="tags"><span class="sync">Sync</span></span> |
+| [<span>Repository#</span>createTag <span>(String, name, message)</span>](/api/repository/#createTag) |  <span class="tags"><span class="async">Async</span></span> |
+| [<span>Repository#</span>deleteTagByName <span>(Short)</span>](/api/repository/#deleteTagByName) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>detachHead <span>(signature, reflog_message)</span>](/api/repository/#detachHead) |  <span class="tags"><span class="sync">Sync</span></span> |
 | [<span>Repository#</span>free <span>()</span>](/api/repository/#free) |  <span class="tags"><span class="sync">Sync</span></span> |
 | [<span>Repository#</span>getBlob <span>(String)</span>](/api/repository/#getBlob) |  <span class="tags"><span class="async">Async</span></span> |
@@ -1292,6 +1311,7 @@ sections:
 | [<span>Repository#</span>getReferenceCommit <span>(name)</span>](/api/repository/#getReferenceCommit) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>getReferenceNames <span>(type)</span>](/api/repository/#getReferenceNames) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>getReferences <span>(type)</span>](/api/repository/#getReferences) |  <span class="tags"><span class="async">Async</span></span> |
+| [<span>Repository#</span>getStatusExt <span>(opts)</span>](/api/repository/#getStatusExt) |  <span class="tags"><span class="sync">Sync</span></span> |
 | [<span>Repository#</span>getTag <span>(String)</span>](/api/repository/#getTag) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>getTagByName <span>(Short)</span>](/api/repository/#getTagByName) |  <span class="tags"><span class="async">Async</span></span> |
 | [<span>Repository#</span>getTree <span>(String)</span>](/api/repository/#getTree) |  <span class="tags"><span class="async">Async</span></span> |

api/remote/index.md

@@ -15,6 +15,7 @@ sections:
   "isValidName": "#isValidName"
   "list": "#list"
   "lookup": "#lookup"
+  "push": "#push"
   "#addFetch": "#addFetch"
   "#addPush": "#addPush"
   "#autotag": "#autotag"
@@ -188,6 +189,28 @@ Retrieves the remote by name
 | --- | --- |
 | [Remote](/api/remote/) |  |
 
+## <a name="push"></a><span>Remote.</span>push <span class="tags"><span class="async">Async</span></span>
+
+```js
+Remote.push(refSpecs, options, signature, message).then(function(number) {
+  // Use number
+});
+```
+
+Pushes to a remote
+
+
+| Parameters | Type |   |
+| --- | --- | --- |
+| refSpecs | Array | The ref specs that should be pushed |
+| options | [PushOptions](/api/push_options/) | Options for the checkout |
+| signature | [Signature](/api/signature/) | The identity to use for the reflog of the updated references |
+| message | String | The message to use for the update reflog messages |
+
+| Returns |  |
+| --- | --- |
+| Number | error code |
+
 ## <a name="addFetch"></a><span>Remote#</span>addFetch <span class="tags"><span class="sync">Sync</span></span>
 
 ```js