Skip to content

markdown-link-check

GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

markdown-link-check - GitHub

Configuration in MegaLinter

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_COMMAND_REMOVE_ARGUMENTS User custom arguments to remove from command line before calling the linter
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
list_of_files
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_UNSECURED_ENV_VARIABLES List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWN_LINK_CHECK and its pre/post commands None
MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE markdown-link-check configuration file nameUse 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 MegaLinter 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
MARKDOWN_MARKDOWN_LINK_CHECK_CLI_EXECUTABLE Override CLI executable ['markdown-link-check']

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 121 Docker Image Size (tag) Docker Pulls
c_cpp Optimized for pure C/C++ projects 54 Docker Image Size (tag) Docker Pulls
cupcake MegaLinter for the most commonly used languages 83 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 50 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 63 Docker Image Size (tag) Docker Pulls
dotnetweb Optimized for C, C++, C# or VB based projects with JS/TS 72 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 52 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 53 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 59 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 53 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 61 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 50 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 50 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 54 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 50 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 54 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .md

How the linting is performed

  • markdown-link-check is called once with the list of files as arguments (list_of_files CLI lint mode)

Example calls

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

Help content

(node:1700) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
Usage: markdown-link-check [options] [filenamesOrUrls...]

Options:
  -V, --version           output the version number
  -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
  --projectBaseUrl <url>  the URL to use for {{BASEURL}} replacement
  -h, --help              display help for command

Installation on mega-linter Docker image