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).

The Rust alternative is rumdl, a Markdown linter written in Rust with markdownlint’s rules.

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.checker.markdownlint]
command = "markdownlint"               # Path to the markdownlint binary
args = []                              # Additional arguments to pass to markdownlint
dep_inputs = []                      # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
commandstring"markdownlint"Path to the markdownlint executable
argsstring[][]Extra arguments passed to markdownlint
dep_inputsstring[][]Extra files whose changes trigger rebuilds

Batch support

The tool processes one file at a time. Each file is checked in a separate invocation.

Clean behavior

This processor is a Checker — rsconstruct clean outputs is a no-op for it (checkers produce no outputs). See Clean behavior and rsconstruct clean.