Skip to content

markdownlint

markdownlint documentation

markdownlint - GitHub

Configuration in Mega-Linter

Variable Description Default value
MARKDOWN_DEFAULT_STYLE For markdownlint to be active, MARKDOWN_DEFAULT_STYLE must be markdownlint markdownlint
MARKDOWN_MARKDOWNLINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src|lib)
Include every file
MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test|examples)
Exclude no file
MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".md"]
MARKDOWN_MARKDOWNLINT_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_MARKDOWNLINT_CONFIG_FILE markdownlint configuration file name
Use LINTER_DEFAULT to let the linter find it
.markdown-lint.json
MARKDOWN_MARKDOWNLINT_RULES_PATH Path where to find linter configuration file Workspace folder, then Mega-Linter default rules
MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS Run linter but consider errors as warnings true

IDE Integration

Use markdownlint in your favorite IDE to catch errors before Mega-Linter !

IDE Extension Name Install
Atom linter-node-markdownlint Visit Web Site
Sublime Text SublimeLinter-contrib-markdownlint Visit Web Site
vim coc-markdownlint Visit Web Site
Visual Studio Code vscode-markdownlint Install in VsCode

Mega-Linter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default Mega-Linter Flavor 83 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 37 Docker Image Size (tag) Docker Pulls
documentation Mega-Linter for documentation projects 36 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 42 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 38 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 37 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 45 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 40 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 43 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 37 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 37 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 37 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 37 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 37 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 39 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .md

Example calls

markdownlint myfile.md
markdownlint -c .markdown-lint.json myfile.md
markdownlint --fix -c .markdown-lint.json myfile.md

Help content

Usage: markdownlint [options] <files|directories|globs>

MarkdownLint Command Line Interface

Options:
  -V, --version                               output the version number
  -f, --fix                                   fix basic errors (does not work with STDIN)
  -s, --stdin                                 read from STDIN (does not work with files)
  -o, --output [outputFile]                   write issues to file (no console)
  -c, --config [configFile]                   configuration file (JSON, JSONC, JS, or YAML)
  -i, --ignore [file|directory|glob]          file(s) to ignore/exclude (default: [])
  -p, --ignore-path [file]                    path to file with ignore pattern(s)
  -r, --rules  [file|directory|glob|package]  custom rule files (default: [])
  -h, --help                                  display help for command

Installation on mega-linter Docker image

Example success log

Results of markdownlint linter (version 0.25.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/markdown_markdownlint/
-----------------------------------------------

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


Example error log

Results of markdownlint linter (version 0.25.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/markdown_markdownlint/
-----------------------------------------------

[ERROR] .automation/test/markdown/markdown_bad_1.md
    .automation/test/markdown/markdown_bad_1.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "## Bad Markdown"]
    .automation/test/markdown/markdown_bad_1.md:5 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h6]
    .automation/test/markdown/markdown_bad_1.md:11:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 6]
    .automation/test/markdown/markdown_bad_1.md:13 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
    .automation/test/markdown/markdown_bad_1.md:20:16 MD034/no-bare-urls Bare URL used [Context: "https://github.com"]