webhintio / markdown-link-validator Goto Github PK

Validate markdown links

License: Apache License 2.0

TypeScript 97.03% JavaScript 2.97%

markdown-link-validator's Introduction

markdown-link-validator

markdown-link-validator is a CLI tool that validates all the links in your markdown files (external or internal). There are multiple tools that validate links to external urls, but none that validate relative URLs. markdown-link-validator will verify that the file you are pointing at exists in your file system. Even more, if it links to a heading in the document it will validate it exists as well!

Usage

Install it globally npm install -g markdown-link-validator or locally as a devDependency via npm install -D markdown-link-validator.

Then execute it passing the folder to analyze as the first parameter:

markdown-link-validator ./documentation

Options

markdown-link-validator ./path/to/mds [options]

Basic configuration:
  -i, --ignorePatterns path::[String]  Regex to ignore links - default: []
  -f, --flags path::String  Flags applied to the ignore pattern
  -h, --help                Show help

Miscellaneous:
  --debug                   Output debugging information

The following will analyze all the .md files found under ./docs and ignore any links that match the regular expression /https?:\/\/test\.com\/.*/gi:

markdown-link-validator ./docs -i https?:\/\/test\.com\/.* -f gi

The regular expression is passed via the -i parameter, and its flags via -f.

markdown-link-validator's People

Contributors

Stargazers

Watchers

Forkers

sarvaje fossabot chmac mi-hol jenkin sitedata

markdown-link-validator's Issues

[Docs Bug] Add docs improvement idea here

@rizqventure commented on Sat Apr 03 2021

📚 Request documentation enhancements

Description

Details

Relative Image links are reported as invalid

In my markdown I have an image link like below:

![Some Image](./images/diagram.png)

This is valid and the image exist but the validator marks it as invalid.

Example in readme for ignore patterns does not work

When I run markdown-link-validator ./docs -i https?:\/\/test\.com\/.* -f gi as suggested in the README I get:

Error: Value for 'ignorePatterns' of type 'path::[String]' required.

Add support to check Link labels

# Title

Text with a [link][asdf].


[link]: http://example.com

This markdown should report one error, because the link label doesn't exists, but it doesn't, it just check if http://example.com exists

[Proposal] Updates, fixes and new features

I think this project has unique features (ie. built-in globbing and direct md analysis without compilation to html) among competitors (ie. markdown-link-check) and is good enough to deserve a proper evolution path in next future.

For an internal open source project (a knowledge base written in markdown and powered by Raneto) I took the v1.0.1 (8 Jun 2021) of markdown-link-validator and made some changes to adapt it to our requirements: https://github.com/jenkin/markdown-link-validator/.

update all dependencies and resolve all known vulnerabilities highlighted by npm audit
add support to absolute local links (ie. [internal page](/path/to/page.md))
[-q option] add a quiet mode to report only errors if present (see issue #6)
[-e option] add support to optional .md extension (ie. for [internal page](./path/to/page) it searches also for [internal page](./path/to/page.md) or [internal page](./path/to/page/index.md)
[-o option] add support to other extension checking (ie. [local asset](./path/to/image.png) (see issue #27)
ignore links in code blocks and inline code
add support to standalone links checking (ie. without [anchor](https...) or [anchor] https...)
[-c option] ignoring failing external urls based on response status codes (added to final report)
[--ignorePatternsFrom option] ignoring files by patterns taken from a file
[--noEmptyFiles option] raising error if linked files are empty

No breaking changes to the API are introduced. All existing options have the same behavior and defaults and new optional features depends on options disabled by default. Only 2), 6) and 7) are opinionated and could require some discussions. All new features have tests (but I know we can improved them further).

All changes live on feature/sparkfabrik-enhancements branch. I think all of them can met a broader interest beyond our company playbook, so I propose you to review my work and consider to accept a PR and update the npm package.

Allow show only the errors in the report.

When we are validating a lot of files, it can be difficult to find the errors.