theoludwig/markdownlint-rule-relative-links
1
1
Fork 0
mirror of https://github.com/theoludwig/markdownlint-rule-relative-links.git synced 2025-05-27 11:37:24 +02:00
Code Issues Releases Activity

build(deps): update latest

Browse Source
This commit is contained in:
Divlo
2023-05-13 16:03:06 +02:00
parent c985af6156
commit c65607bcc3
11 changed files with 1034 additions and 519 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
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`.
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).
### Example
@ -40,7 +40,7 @@ With `awesome.md` content:
[Dead link](./dead.txt)
```
Running `markdownlint-cli2` with `markdownlint-rule-relative-links` will output:
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]
@ -64,9 +64,9 @@ npm install --save-dev markdownlint-rule-relative-links
## Configuration
There are various ways `markdownlint` can be configured using objects, config files etc. For more information on `markdownlint` configuration refer [options.config](https://github.com/DavidAnson/markdownlint#optionsconfig).
There are various ways [markdownlint](https://github.com/DavidAnson/markdownlint) can be configured using objects, config files etc. For more information on configuration refer to [options.config](https://github.com/DavidAnson/markdownlint#optionsconfig).
We recommend configuring `markdownlint-cli2` over `markdownlint-cli` for compatibility with the `vscode-markdownlint` plugin.
We recommend configuring [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) over [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) for compatibility with the [vscode-markdownlint](https://github.com/DavidAnson/vscode-markdownlint) extension.
`.markdownlint-cli2.jsonc`