FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Style guides index · nodegit/nodegit.github.com@f765eaa · GitHub

/ nodegit.github.com Public

Commit f765eaa

Browse files
orderedlist
committed
Style guides index
1 parent d1a47c9 commit f765eaa

22 files changed

Lines changed: 462 additions & 176 deletions

File tree

‎_layouts/guides.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: full
3+
---
4+
5+
{% assign sections = page.content|split:'***' %}
6+
<div class="guides">
7+
{% for section in sections %}
8+
<div class="document">
9+
{{ section | markdownify }}
10+
</div>
11+
{% endfor %}
12+
</div>

‎_sass/_layout.scss‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,13 @@ header {
224224

225225
ul {
226226
border:none;
227+
list-style:none;
228+
229+
li {
230+
padding:0;
231+
background:none;
232+
margin:0;
233+
}
227234
}
228235
}
229236

@@ -258,6 +265,64 @@ header {
258265
}
259266
}
260267
}
268+
269+
ul {
270+
list-style:disc;
271+
272+
li {
273+
margin:0 0 8px;
274+
padding:0 0 0 25px;
275+
background-image:url(/img/nodegit-mark.svg);
276+
background-repeat:no-repeat;
277+
background-size:16px;
278+
background-position:0 5px;
279+
}
280+
}
281+
282+
.guides {
283+
padding:0;
284+
margin:0;
285+
286+
.document {
287+
width:30%;
288+
float:left;
289+
box-sizing:border-box;
290+
position:relative;
291+
margin:0 5% 30px 0;
292+
293+
h2 {
294+
padding-bottom:8px;
295+
border-bottom:1px solid #ededed;
296+
297+
a {
298+
color:#222;
299+
}
300+
}
301+
302+
blockquote {
303+
border:none;
304+
margin:-10px 0 0;
305+
padding:0;
306+
color:#999;
307+
}
308+
309+
ul {
310+
list-style:none;
311+
312+
li {
313+
margin-left:0;
314+
}
315+
}
316+
317+
&:nth-child(3n) {
318+
margin-right:0;
319+
}
320+
321+
&:nth-child(3n+1) {
322+
clear:left;
323+
}
324+
}
325+
}
261326
}
262327

263328
span.tags {
@@ -405,6 +470,29 @@ table {
405470
.outline {
406471
display:none;
407472
}
473+
474+
.guides {
475+
.document {
476+
width:45%;
477+
478+
&:nth-child(3n+1) {
479+
clear:none;
480+
}
481+
482+
&:nth-child(3n) {
483+
clear:none;
484+
margin-right:5%;
485+
}
486+
487+
&:nth-child(2n+1) {
488+
clear:left;
489+
}
490+
491+
&:nth-child(2n) {
492+
margin-right:0;
493+
}
494+
}
495+
}
408496
}
409497
}
410498

@@ -489,4 +577,14 @@ table {
489577
}
490578
}
491579
}
580+
581+
.page-content {
582+
.guides {
583+
.document {
584+
float:none;
585+
width:100%;
586+
margin:0 0 30px;
587+
}
588+
}
589+
}
492590
}

‎api/diff/index.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ sections:
1212
"treeToTree": "#treeToTree"
1313
"treeToWorkdir": "#treeToWorkdir"
1414
"treeToWorkdirWithIndex": "#treeToWorkdirWithIndex"
15+
"#findSimilar": "#findSimilar"
1516
"#getDelta": "#getDelta"
1617
"#getPerfdata": "#getPerfdata"
1718
"#numDeltas": "#numDeltas"
@@ -118,6 +119,22 @@ Diff.treeToWorkdirWithIndex(repo, old_tree, opts).then(function(diff) {
118119
| --- | --- |
119120
| [Diff](/api/diff/) | |
120121

122+
## <a name="findSimilar"></a><span>Diff#</span>findSimilar <span class="tags"><span class="async">Async</span></span>
123+
124+
```js
125+
diff.findSimilar(options).then(function(result) {
126+
// Use result
127+
});
128+
```
129+
130+
| Parameters | Type |
131+
| --- | --- | --- |
132+
| options | [DiffFindOptions](/api/diff_find_options/) | Control how detection should be run, NULL for defaults |
133+
134+
| Returns | |
135+
| --- | --- |
136+
| Number | 0 on success, -1 on failure |
137+
121138
## <a name="getDelta"></a><span>Diff#</span>getDelta <span class="tags"><span class="sync">Sync</span></span>
122139

123140
```js

‎api/diff_find_options/index.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: default
3+
menu_item: api
4+
title: DiffFindOptions
5+
description: Version 0.3.0
6+
menu_item: api
7+
return_to:
8+
"API Documentation Index": /api/
9+
sections:
10+
"Instance Variables": "#ivars"
11+
---
12+
13+
```js
14+
var diffFindOptions = new DiffFindOptions();
15+
```
16+
17+
## <a name="ivars"></a>Instance Variables
18+
19+
| Variable | Type |
20+
| --- | --- |
21+
| <a name="breakRewriteThreshold"></a>breakRewriteThreshold | Number |
22+
| <a name="copyThreshold"></a>copyThreshold | Number |
23+
| <a name="flags"></a>flags | Number |
24+
| <a name="renameFromRewriteThreshold"></a>renameFromRewriteThreshold | Number |
25+
| <a name="renameLimit"></a>renameLimit | Number |
26+
| <a name="renameThreshold"></a>renameThreshold | Number |
27+
| <a name="version"></a>version | Number |
28+

‎api/index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ sections:
3636
"Diff": "#Diff"
3737
"DiffDelta": "#DiffDelta"
3838
"DiffFile": "#DiffFile"
39+
"DiffFindOptions": "#DiffFindOptions"
3940
"DiffHunk": "#DiffHunk"
4041
"DiffLine": "#DiffLine"
4142
"DiffOptions": "#DiffOptions"
@@ -522,6 +523,7 @@ sections:
522523

523524
| Instance Methods | |
524525
| --- | ---: |
526+
| [<span>Diff#</span>findSimilar <span>(options)</span>](/api/diff/#findSimilar) | <span class="tags"><span class="async">Async</span></span> |
525527
| [<span>Diff#</span>getDelta <span>(idx)</span>](/api/diff/#getDelta) | <span class="tags"><span class="sync">Sync</span></span> |
526528
| [<span>Diff#</span>getPerfdata <span>()</span>](/api/diff/#getPerfdata) | <span class="tags"><span class="async">Async</span></span> |
527529
| [<span>Diff#</span>numDeltas <span>()</span>](/api/diff/#numDeltas) | <span class="tags"><span class="sync">Sync</span></span> |
@@ -562,6 +564,19 @@ sections:
562564
| [<span>DiffFile#</span>size](/api/diff_file/#size) | |
563565

564566

567+
## <a name='DiffFindOptions'></a>[DiffFindOptions](/api/diff_find_options/)
568+
569+
| Instance Variables | |
570+
| --- | ---: |
571+
| [<span>DiffFindOptions#</span>breakRewriteThreshold](/api/diff_find_options/#breakRewriteThreshold) | |
572+
| [<span>DiffFindOptions#</span>copyThreshold](/api/diff_find_options/#copyThreshold) | |
573+
| [<span>DiffFindOptions#</span>flags](/api/diff_find_options/#flags) | |
574+
| [<span>DiffFindOptions#</span>renameFromRewriteThreshold](/api/diff_find_options/#renameFromRewriteThreshold) | |
575+
| [<span>DiffFindOptions#</span>renameLimit](/api/diff_find_options/#renameLimit) | |
576+
| [<span>DiffFindOptions#</span>renameThreshold](/api/diff_find_options/#renameThreshold) | |
577+
| [<span>DiffFindOptions#</span>version](/api/diff_find_options/#version) | |
578+
579+
565580
## <a name='DiffHunk'></a>[DiffHunk](/api/diff_hunk/)
566581

567582
| Instance Variables | |
@@ -1209,6 +1224,7 @@ sections:
12091224
| [<span>Remote.</span>isValidName <span>(remote_name)</span>](/api/remote/#isValidName) | <span class="tags"><span class="sync">Sync</span></span> |
12101225
| [<span>Remote.</span>list <span>(repo)</span>](/api/remote/#list) | <span class="tags"><span class="async">Async</span></span> |
12111226
| [<span>Remote.</span>lookup <span>(repo, name, callback)</span>](/api/remote/#lookup) | <span class="tags"><span class="async">Async</span></span> |
1227+
| [<span>Remote.</span>push <span>(refSpecs, options, signature, message)</span>](/api/remote/#push) | <span class="tags"><span class="async">Async</span></span> |
12121228

12131229
| Instance Methods | |
12141230
| --- | ---: |
@@ -1279,7 +1295,10 @@ sections:
12791295
| --- | ---: |
12801296
| [<span>Repository#</span>config <span>()</span>](/api/repository/#config) | <span class="tags"><span class="async">Async</span></span> |
12811297
| [<span>Repository#</span>configSnapshot <span>()</span>](/api/repository/#configSnapshot) | <span class="tags"><span class="async">Async</span></span> |
1298+
| [<span>Repository#</span>createLightweightTag <span>(String, name)</span>](/api/repository/#createLightweightTag) | <span class="tags"><span class="async">Async</span></span> |
12821299
| [<span>Repository#</span>createRevWalk <span>(String)</span>](/api/repository/#createRevWalk) | <span class="tags"><span class="sync">Sync</span></span> |
1300+
| [<span>Repository#</span>createTag <span>(String, name, message)</span>](/api/repository/#createTag) | <span class="tags"><span class="async">Async</span></span> |
1301+
| [<span>Repository#</span>deleteTagByName <span>(Short)</span>](/api/repository/#deleteTagByName) | <span class="tags"><span class="async">Async</span></span> |
12831302
| [<span>Repository#</span>detachHead <span>(signature, reflog_message)</span>](/api/repository/#detachHead) | <span class="tags"><span class="sync">Sync</span></span> |
12841303
| [<span>Repository#</span>free <span>()</span>](/api/repository/#free) | <span class="tags"><span class="sync">Sync</span></span> |
12851304
| [<span>Repository#</span>getBlob <span>(String)</span>](/api/repository/#getBlob) | <span class="tags"><span class="async">Async</span></span> |
@@ -1292,6 +1311,7 @@ sections:
12921311
| [<span>Repository#</span>getReferenceCommit <span>(name)</span>](/api/repository/#getReferenceCommit) | <span class="tags"><span class="async">Async</span></span> |
12931312
| [<span>Repository#</span>getReferenceNames <span>(type)</span>](/api/repository/#getReferenceNames) | <span class="tags"><span class="async">Async</span></span> |
12941313
| [<span>Repository#</span>getReferences <span>(type)</span>](/api/repository/#getReferences) | <span class="tags"><span class="async">Async</span></span> |
1314+
| [<span>Repository#</span>getStatusExt <span>(opts)</span>](/api/repository/#getStatusExt) | <span class="tags"><span class="sync">Sync</span></span> |
12951315
| [<span>Repository#</span>getTag <span>(String)</span>](/api/repository/#getTag) | <span class="tags"><span class="async">Async</span></span> |
12961316
| [<span>Repository#</span>getTagByName <span>(Short)</span>](/api/repository/#getTagByName) | <span class="tags"><span class="async">Async</span></span> |
12971317
| [<span>Repository#</span>getTree <span>(String)</span>](/api/repository/#getTree) | <span class="tags"><span class="async">Async</span></span> |

‎api/remote/index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ sections:
1515
"isValidName": "#isValidName"
1616
"list": "#list"
1717
"lookup": "#lookup"
18+
"push": "#push"
1819
"#addFetch": "#addFetch"
1920
"#addPush": "#addPush"
2021
"#autotag": "#autotag"
@@ -188,6 +189,28 @@ Retrieves the remote by name
188189
| --- | --- |
189190
| [Remote](/api/remote/) | |
190191

192+
## <a name="push"></a><span>Remote.</span>push <span class="tags"><span class="async">Async</span></span>
193+
194+
```js
195+
Remote.push(refSpecs, options, signature, message).then(function(number) {
196+
// Use number
197+
});
198+
```
199+
200+
Pushes to a remote
201+
202+
203+
| Parameters | Type | |
204+
| --- | --- | --- |
205+
| refSpecs | Array | The ref specs that should be pushed |
206+
| options | [PushOptions](/api/push_options/) | Options for the checkout |
207+
| signature | [Signature](/api/signature/) | The identity to use for the reflog of the updated references |
208+
| message | String | The message to use for the update reflog messages |
209+
210+
| Returns | |
211+
| --- | --- |
212+
| Number | error code |
213+
191214
## <a name="addFetch"></a><span>Remote#</span>addFetch <span class="tags"><span class="sync">Sync</span></span>
192215

193216
```js

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL