Skip to content

Commit 7f4da6e

Browse files
dialexwooorm
authored andcommitted
Add more explicit note about internal links
Closes GH-20.
1 parent 91449c6 commit 7f4da6e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

readme.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# remark-validate-links [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
22

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
44
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).
57

68
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
810
about it.
911

1012
In addition, when I link to a heading in another document
1113
(`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.
1315

1416
Linking to other files, such as `LICENSE` or `index.js` (when they exist)
1517
is fine.
@@ -157,6 +159,7 @@ on nodes:
157159
## Related
158160

159161
* [`remark-lint`][remark-lint] — Markdown code style linter
162+
* [`remark-lint-no-dead-urls`][no-dead-urls] — Ensure external links are alive
160163

161164
## Contribute
162165

@@ -194,6 +197,8 @@ repository, organisation, or community you agree to abide by its terms.
194197

195198
[remark-lint]: https://github.com/remarkjs/remark-lint
196199

200+
[no-dead-urls]: https://github.com/davidtheclark/remark-lint-no-dead-urls
201+
197202
[remark-html]: https://github.com/remarkjs/remark-html
198203

199204
[package-repository]: https://docs.npmjs.com/files/package.json#repository

0 commit comments

Comments
 (0)