Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Markdownlint Processor

Purpose

Lints Markdown files using markdownlint (Node.js).

How It Works

Discovers .md files in the project and runs markdownlint on each file. A non-zero exit code fails the product.

Depends on the npm processor — uses the markdownlint binary installed by npm.

Source Files

  • Input: **/*.md
  • Output: none (checker)

Configuration

[processor.markdownlint]
markdownlint_bin = "node_modules/.bin/markdownlint"  # Path to the markdownlint binary
args = []                              # Additional arguments to pass to markdownlint
npm_stamp = "out/npm/root.stamp"       # Stamp file from npm processor (dependency)
extra_inputs = []                      # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
markdownlint_binstring"node_modules/.bin/markdownlint"Path to the markdownlint executable
argsstring[][]Extra arguments passed to markdownlint
npm_stampstring"out/npm/root.stamp"Stamp file from npm processor (ensures npm packages are installed first)
extra_inputsstring[][]Extra files whose changes trigger rebuilds