Skip to content

Commit 0a326df

Browse files
authored
Update guide-browser.md (#18)
* Update guide-browser.md * Update guide-quickstart.md
1 parent 40ca4db commit 0a326df

File tree

2 files changed

+7
-14
lines changed

2 files changed

+7
-14
lines changed

docs/guide-browser.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,6 @@ Let's see what the recent history of this branch looks like.
7272
await git.log({fs, dir})
7373
```
7474

75-
Notice if you expand the very last log object you'll see it is actually an error message.
76-
That's because we only fetched 10 commits of history - we don't have the 11th commit.
77-
78-
If we don't want that error at the end of the array, we can tell git.log exactly how deep to go:
79-
80-
```js live
81-
await git.log({fs, dir, depth: $input((10))})
82-
```
83-
8475
Git is used to track files. Let's see what kind of file things we can do!
8576

8677
git.status is a major one. That let's us compare the working directory file to the current branch.
@@ -97,8 +88,8 @@ await pfs.writeFile(`${dir}/README.md`, 'Very short README', 'utf8')
9788
await git.status({fs, dir, filepath: 'README.md'})
9889
```
9990

100-
The status is "*modified" with a star.
101-
Text editors sometimes use a "*" in the title bar to indicate a file has unsaved changes.
91+
The status is "\*modified" with a star.
92+
Text editors sometimes use a "\*" in the title bar to indicate a file has unsaved changes.
10293
That's what is going on here - we've made changes to the file but we haven't added those changes to the git "staging area".
10394

10495
```js live
@@ -115,7 +106,7 @@ await pfs.writeFile(`${dir}/newfile.txt`, 'Hello World', 'utf8')
115106
await git.status({fs, dir, filepath: 'newfile.txt'})
116107
```
117108

118-
"*added" means the file has been added, but not staged. Simple to fix:
109+
"\*added" means the file has been added, but not staged. Simple to fix:
119110

120111
```js live
121112
await git.add({fs, dir, filepath: 'newfile.txt'})
@@ -174,6 +165,7 @@ commits = await git.log({fs, dir, depth: 1})
174165
commits[0]
175166
```
176167

168+
<!--
177169
I just had a brilliant idea. What if instead of starting out cloning `isomorphic-git`
178170
I had you the user create a new Github repo at the beginning with a default 'LICENSE.md' and 'README.md'?
179171
Then we could actually push the changes we've made here in this last step.
@@ -182,3 +174,4 @@ When you create the repo, I'll have to add instructions for creating an access t
182174
you can push the results. Wait, Github doesn't allow you to specify write permissions for an individual repo?
183175
Grr now they'll have to create an organization... wait that's a permanent name thing... ugh. I need
184176
to build a bot to automate this thing. It can create the repo, then give *you* access to it. Or something.
177+
-->

docs/guide-quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ sidebar_label: Quick Start
66

77
## Node Quick Start
88

9-
Try out the interactive [Quick Start guide on Runkit](https://runkit.com/wmhilton/5a89cd94303ded001277664c)
9+
Try out the interactive [Quick Start guide on Runkit](https://runkit.com/wmhilton/isomorphic-git-quick-start)
1010

1111
## Browser Quick Start
1212

13-
Try out isomorphic-git right here [in your browser](browser.html)
13+
Try out isomorphic-git right here [in your browser](browser.html)

0 commit comments

Comments
 (0)