This application is used to find broken links at markdown files.
Providers are the core of markdown-link-check. They enable the application to perform new kinds of checks like validating a resource that exists in Jira or even at an FTP server.
The file provider checks if the links point to valid files or directories. If the link points to a file and it has an anchor it will be validated as well.
There is initial support for verification on private GitHub repositories. More information can be found at #7.
The web provider verifies public HTTP endpoints. The link is assumed as valid if the status code is >=200 and <300. The redirect status code 301 and 308 will be followed, other redirect codes are treated as an invalid link.
git clone [email protected]:Nitro/markdown-link-check.git
cd markdown-link-check
make go-build # This generate a binary at './cmd/markdown-link-check'➜ ./markdown-link-check --help
Usage: markdown-link-check --config=STRING <path>
Arguments:
<path> Path to be processed
Flags:
--help Show context-sensitive help.
-c, --config=STRING Path to the configuration file.There is a action available.
It's possible to build from the source or use a pre-built release.