Skip to content

Commit 5b815cb

Browse files
committed
Fix current errors in Markdown files
Also: add package-lock.json to gitignore Remove prefix $ for commands in the manpage, hope people aren't angry Add MD034 to markdownlint ignore (bare links, which are helpful for the manpage)
1 parent 702b8a6 commit 5b815cb

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules/
22
sandboxrepo
33
git-open.1
4+
package-lock.json

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,12 @@ from which this plugin was forked.
130130
Please provide examples of the URLs you are parsing with each PR.
131131
132132
You can run `git-open` in `echo` mode, which doesn't open your browser, but just prints the URL to stdout:
133+
133134
```sh
134135
env BROWSER='echo' ./git-open
135136
```
136137
137-
#### Testing:
138+
### Testing:
138139
139140
You'll need to install [bats](https://github.com/sstephenson/bats#installing-bats-from-source), the Bash automated testing system. It's also available as `brew install bats`
140141

git-open.1.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,25 @@ git hosting services are supported.
2626
## EXAMPLES
2727

2828
```sh
29-
$ git open
29+
git open
3030
```
3131

3232
It opens https://github.com/TRACKED_REMOTE_USER/CURRENT_REPO/
3333

3434
```sh
35-
$ git open someremote
35+
git open someremote
3636
```
3737

3838
It opens https://github.com/PROVIDED_REMOTE_USER/CURRENT_REPO/
3939

4040
```sh
41-
$ git open someremote somebranch
41+
git open someremote somebranch
4242
```
4343

4444
It opens https://github.com/PROVIDED_REMOTE_USER/CURRENT_REPO/tree/PROVIDED_BRANCH
4545

4646
```sh
47-
$ git open --issue
47+
git open --issue
4848
```
4949

5050
If branches use naming convention of `issues/#123`, it opens
@@ -72,7 +72,7 @@ To configure git-open you may need to set some `git config` options.
7272
You can use `--global` to set across all repos, instead of just the current repo.
7373

7474
```sh
75-
$ git config [--global] option value
75+
git config [--global] option value
7676
```
7777

7878
### Configuring which remote to open
@@ -106,6 +106,7 @@ git config [--global] open.[gitdomain].protocol [value]
106106
```
107107

108108
**Example**
109+
109110
- Your git remote is at `ssh://[email protected]:7000/XXX/YYY.git`
110111
- Your hosted gitlab is `http://repo.intranet/subpath/XXX/YYY`
111112

markdownlint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"MD013": false,
1010
"MD026": false,
1111
"MD033": false,
12+
"MD034": false,
1213
"MD036": false,
1314
"MD041": false
1415
}

0 commit comments

Comments
 (0)