markdown-link-check

markdown-link-check documentation

Visit Official Web Site
See How to configure markdown-link-check rules
- If custom .markdown-link-check.json config file is not found, .markdown-link-check.json will be used
See How to disable markdown-link-check rules in files

Configuration in Mega-Linter

Enable markdown-link-check by adding MARKDOWN_MARKDOWN_LINK_CHECK in ENABLE_LINTERS variable
Disable markdown-link-check by adding MARKDOWN_MARKDOWN_LINK_CHECK in DISABLE_LINTERS variable

Variable	Description	Default value
MARKDOWN_MARKDOWN_LINK_CHECK_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
MARKDOWN_MARKDOWN_LINK_CHECK_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `list_of_files`: Call the linter with the list of files as argument - `project`: Call the linter from the root of the project	`{linter.cli_lint_mode}`
MARKDOWN_MARKDOWN_LINK_CHECK_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".md"]`
MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
MARKDOWN_MARKDOWN_LINK_CHECK_PRE_COMMANDS	List of bash commands to run before the linter	None
MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS	List of bash commands to run after the linter	None
MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE	markdown-link-check configuration file name Use `LINTER_DEFAULT` to let the linter find it	`.markdown-link-check.json`
MARKDOWN_MARKDOWN_LINK_CHECK_RULES_PATH	Path where to find linter configuration file	Workspace folder, then Mega-Linter default rules
MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`

Mega-Linter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default Mega-Linter Flavor	94
dart	Optimized for DART based projects	41
documentation	Mega-Linter for documentation projects	40
dotnet	Optimized for C, C++, C# or VB based projects	47
go	Optimized for GO based projects	42
java	Optimized for JAVA based projects	42
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
php	Optimized for PHP based projects	44
python	Optimized for PYTHON based projects	49
ruby	Optimized for RUBY based projects	41
rust	Optimized for RUST based projects	41
salesforce	Optimized for Salesforce based projects	43
scala	Optimized for SCALA based projects	41
swift	Optimized for SWIFT based projects	41
terraform	Optimized for TERRAFORM based projects	45

Behind the scenes

How are identified applicable files

File extensions: .md

How the linting is performed

markdown-link-check is called one time by identified file

Example calls

markdown-link-check myfile.md

markdown-link-check -c .markdown-link-check.json myfile.md

Help content

Usage: markdown-link-check [options] [filenameOrUrl]

Options:
  -p, --progress         show progress bar
  -c, --config [config]  apply a config file (JSON), holding e.g. url specific
                         header configuration
  -q, --quiet            displays errors only
  -v, --verbose          displays detailed error information
  -a, --alive <code>     comma separated list of HTTP codes to be considered as
                         alive
  -r, --retry            retry after the duration indicated in 'retry-after'
                         header when HTTP code is 429
  -h, --help             display help for command

Installation on mega-linter Docker image

NPM packages (node.js):
- markdown-link-check

Example success log

Results of markdown-link-check linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/markdown_markdown_link_check/
-----------------------------------------------

[SUCCESS] .automation/test/markdown/markdown_good_1.md

    FILE: .automation/test/markdown/markdown_good_1.md
    [✓] https://github.com

    1 links checked.

Example error log

Results of markdown-link-check linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/markdown_markdown_link_check/
-----------------------------------------------

[ERROR] .automation/test/markdown/markdown_bad_1.md

    FILE: .automation/test/markdown/markdown_bad_1.md
    [✓] https://github.com
    [✓] #wesh
    [✖] http://www.glouglouglglsdgdfgfdgsfgdfgdf.com

    3 links checked.

    ERROR: 1 dead links found!
    [✖] http://www.glouglouglglsdgdfgfdgsfgdfgdf.com → Status: 0