theoludwig/markdownlint-rule-relative-links
1
1
Fork 0
mirror of https://github.com/theoludwig/markdownlint-rule-relative-links.git synced 2025-11-01 00:49:07 +01:00
Code Issues Releases Activity

feat: improve errors message to distinguish between file system and fragment errors

Browse Source
This commit is contained in:
Théo LUDWIG
2023-06-27 13:15:03 +02:00
parent 6c4e8cec9c
commit a33c682974
4 changed files with 18 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -21,7 +21,7 @@
**markdownlint-rule-relative-links** is a [markdownlint](https://github.com/DavidAnson/markdownlint) custom rule to validate relative links.
It ensures that relative links (using `file:` protocol) are working and not "dead" which means that it exists in the file system of the project that uses [markdownlint](https://github.com/DavidAnson/markdownlint).
It ensures that relative links (using `file:` protocol) are working and exists in the file system of the project that uses [markdownlint](https://github.com/DavidAnson/markdownlint).
### Example
@@ -37,13 +37,13 @@ With `awesome.md` content:
```md
[abc](./abc.txt)
[Dead link](./dead.txt)
[Invalid link](./invalid.txt)
```
Running [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) with `markdownlint-rule-relative-links` will output:
```sh
awesome.md:3 relative-links Relative links should be valid [Link "./dead.txt" is dead]
awesome.md:3 relative-links Relative links should be valid [Link "./invalid.txt" should exist in the file system]
```
### Related links