@@ -1,12 +1,11 @@
11# remark-validate-links [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
22
3−<!--lint disable list-item-spacing-->
4−
53[**remark**][remark] plug-in to validate if links to headings and files
64in markdown point to existing things.
75
8−For example, this document does not have a heading named `Hello`. So if I
9−link to that (`[welcome](#hello)`), this plug-in will warn about it.
6+For example, this document does not have a heading named `Hello`.
7+So if I link to that (`[welcome](#hello)`), this plug-in will warn
8+about it.
109
1110In addition, when I link to a heading in another document
1211(`examples/foo.md#hello`), if this file exists but the heading does not,
@@ -78,7 +77,7 @@ This plug-in is **not** available on the API of remark.
7877## Configuration
7978
8079You can pass a `repository`, containing anything `package.json`s
81−[`repository`][package-repository] can handle. If this is omitted,
80+[`repository`][package-repository] can handle. If this is omitted,
8281**remark-validate-links** will try the `package.json` in your
8382current working directory.
8483
@@ -87,8 +86,8 @@ remark --use 'validate-links=repository:"foo/bar"' example.md
8786```
8887
8988When a repository is given or detected, links to GitHub are normalized
90−to the file-system. E.g., `https://github.com/foo/bar/blob/master/example.md`
91−becomes `example.md`.
89+to the file-system. For example,
90+`https://github.com/foo/bar/blob/master/example.md` becomes `example.md`.
9291
9392You can define this repository in [configuration files][cli] too.
9493An example `.remarkrc` file could look as follows: