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)
This commit is contained in:
August Valera 2018-02-24 22:00:30 -08:00
parent 702b8a6fc6
commit 5b815cb619
4 changed files with 10 additions and 6 deletions

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
node_modules/
sandboxrepo
git-open.1
package-lock.json

View file

@ -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`

View file

@ -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
@ -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
@ -106,6 +106,7 @@ git config [--global] open.[gitdomain].protocol [value]
```
**Example**
- Your git remote is at `ssh://git@git.internal.biz:7000/XXX/YYY.git`
- Your hosted gitlab is `http://repo.intranet/subpath/XXX/YYY`

View file

@ -9,6 +9,7 @@
"MD013": false,
"MD026": false,
"MD033": false,
"MD034": false,
"MD036": false,
"MD041": false
}