Skip to content

Commit

Permalink
Fix current errors in Markdown files
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
4U6U57 committed Feb 25, 2018
1 parent 702b8a6 commit 5b815cb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules/
sandboxrepo
git-open.1
package-lock.json
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,12 @@ from which this plugin was forked.
Please provide examples of the URLs you are parsing with each PR.
You can run `git-open` in `echo` mode, which doesn't open your browser, but just prints the URL to stdout:
```sh
env BROWSER='echo' ./git-open
```
#### Testing:
### Testing:
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`
Expand Down
11 changes: 6 additions & 5 deletions git-open.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,25 @@ git hosting services are supported.
## EXAMPLES

```sh
$ git open
git open
```

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

```sh
$ git open someremote
git open someremote
```

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

```sh
$ git open someremote somebranch
git open someremote somebranch
```

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

```sh
$ git open --issue
git open --issue
```

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

```sh
$ git config [--global] option value
git config [--global] option value
```

### Configuring which remote to open
Expand Down Expand Up @@ -106,6 +106,7 @@ git config [--global] open.[gitdomain].protocol [value]
```

**Example**

- Your git remote is at `ssh:https://[email protected]:7000/XXX/YYY.git`
- Your hosted gitlab is `https://repo.intranet/subpath/XXX/YYY`

Expand Down
1 change: 1 addition & 0 deletions markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"MD013": false,
"MD026": false,
"MD033": false,
"MD034": false,
"MD036": false,
"MD041": false
}

0 comments on commit 5b815cb

Please sign in to comment.