Skip to content

markdown-link-check

markdown-link-check - GitHub

Configuration in Mega-Linter

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_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_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 Info
all Default Mega-Linter Flavor 84 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 38 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 37 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 43 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 39 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 38 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 46 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 41 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 44 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 38 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 38 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 38 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 38 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 38 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 40 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .md

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

Example success log

Results of markdown-link-check linter (version 0.0.0)
See documentation on https://nvuillam.github.io/mega-linter/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://nvuillam.github.io/mega-linter/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