|
1 | 1 | # remark-validate-links [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat] |
2 | 2 |
|
3 | | -[**remark**][remark] plug-in to validate if links to headings and files |
| 3 | +[**remark**][remark] plugin to validate if internal links to headings and files |
4 | 4 | in markdown point to existing things. |
| 5 | +It does not check external URLs (see [`remark-lint-no-dead-urls`][no-dead-urls] |
| 6 | +for that). |
5 | 7 |
|
6 | 8 | 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 |
| 9 | +So if we link to that (`[welcome](#hello)`), this plugin will warn |
8 | 10 | about it. |
9 | 11 |
|
10 | 12 | In addition, when I link to a heading in another document |
11 | 13 | (`examples/foo.md#hello`), if this file exists but the heading does not, |
12 | | -or if the file does not exist, this plug-in will also warn. |
| 14 | +or if the file does not exist, this plugin will also warn. |
13 | 15 |
|
14 | 16 | Linking to other files, such as `LICENSE` or `index.js` (when they exist) |
15 | 17 | is fine. |
@@ -157,6 +159,7 @@ on nodes: |
157 | 159 | ## Related |
158 | 160 |
|
159 | 161 | * [`remark-lint`][remark-lint] — Markdown code style linter |
| 162 | +* [`remark-lint-no-dead-urls`][no-dead-urls] — Ensure external links are alive |
160 | 163 |
|
161 | 164 | ## Contribute |
162 | 165 |
|
@@ -194,6 +197,8 @@ repository, organisation, or community you agree to abide by its terms. |
194 | 197 |
|
195 | 198 | [remark-lint]: https://github.com/remarkjs/remark-lint |
196 | 199 |
|
| 200 | +[no-dead-urls]: https://github.com/davidtheclark/remark-lint-no-dead-urls |
| 201 | + |
197 | 202 | [remark-html]: https://github.com/remarkjs/remark-html |
198 | 203 |
|
199 | 204 | [package-repository]: https://docs.npmjs.com/files/package.json#repository |
|
0 commit comments