@@ -1,7 +1,7 @@
1−# remark-validate-links [](https://travis-ci.org/wooorm/remark-validate-links) [](https://codecov.io/github/wooorm/remark-validate-links)
1+# remark-validate-links [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
22
3−[**remark**](https://github.com/wooorm/remark) plug-in to validate if links to
4−headings and files in markdown point to existing things.
3+[**remark**][remark] plug-in to validate if links to headings and files
4+in markdown point to existing things.
55
66For example, this document does not have a heading named `Hello`. So if I
77link to that (`[welcome](#hello)`), this plug-in will warn about it.
@@ -25,7 +25,7 @@ is fine.
2525
2626## Installation
2727
28−[npm](https://docs.npmjs.com/cli/install):
28+[npm][npm-install]:
2929
3030```bash
3131npm install remark-validate-links
@@ -33,9 +33,9 @@ npm install remark-validate-links
3333
3434## Command line
3535
36−
36+![Example of how remark-validate-links looks on screen][screenshot]
3737
38−Use **remark-validate-links** together with [**remark**](https://github.com/wooorm/remark):
38+Use **remark-validate-links** together with [**remark**][remark]:
3939
4040```bash
4141npm install --global remark remark-validate-links
@@ -76,9 +76,9 @@ This plug-in is **not** available on the API of remark.
7676## Configuration
7777
7878You can pass a `repository`, containing anything `package.json`s
79−[`repository`](https://docs.npmjs.com/files/package.json#repository) can
80−handle. If this is omitted, **remark-validate-links** will try
81−the `package.json` in your current working directory.
79+[`repository`][package-repository] can handle. If this is omitted,
80+**remark-validate-links** will try the `package.json` in your
81+current working directory.
8282
8383```bash
8484remark --use 'validate-links=repository:"foo/bar"' example.md
@@ -88,15 +88,12 @@ When a repository is given or detected, links to GitHub are normalized
8888to the file-system. E.g., `https://github.com/foo/bar/blob/master/example.md`
8989becomes `example.md`.
9090
91−You can define this repository in `.remarkrc` or `package.json` [files](https://github.com/wooorm/remark/blob/master/doc/remarkrc.5.md)
92−too. An example `.remarkrc` file could look as follows:
91+You can define this repository in `.remarkrc` or `package.json`
92+[files][remarkrc] too. An example `.remarkrc` file could look as follows:
9393
9494```json
9595{
9696 "plugins": {
97− "slug": {
98− "library": "github"
99− },
10097 "validate-links": {
10198 "repository": "foo/bar"
10299 }
@@ -120,13 +117,37 @@ several properties on nodes:
120117
121118## Related
122119
123−* [`remark-lint`](https://github.com/wooorm/remark-lint)
120+* [`wooorm/remark-lint`][remark-lint]
124121 — Markdown code style linter.
125122
126123## License
127124
128−[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
125+[MIT][license] © [Titus Wormer][author]
129126
130127<!-- Definitions -->
131128
129+[travis-badge]: https://img.shields.io/travis/wooorm/remark-validate-links.svg
130+
131+[travis]: https://travis-ci.org/wooorm/remark-validate-links
132+
133+[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/remark-validate-links.svg
134+
135+[codecov]: https://codecov.io/github/wooorm/remark-validate-links
136+
137+[npm-install]: https://docs.npmjs.com/cli/install
138+
139+[license]: LICENSE
140+
141+[author]: http://wooorm.com
142+
143+[remark]: https://github.com/wooorm/remark
144+
145+[remark-lint]: https://github.com/wooorm/remark-lint
146+
132147[remark-html]: https://github.com/wooorm/remark-html
148+
149+[screenshot]: https://cdn.rawgit.com/wooorm/remark-validate-links/master/screenshot.png
150+
151+[package-repository]: https://docs.npmjs.com/files/package.json#repository
152+
153+[remarkrc]: https://github.com/wooorm/remark/blob/master/doc/remarkrc.5.md