Linting Markdown

Markdown - Linting

Overview

Lint markdown files in your repository using markdownlint-cli.

The workflow only runs when a pull request modifies **/*.md files.

Usage

Simple:

uses: advanced-security/reusable-workflows/.github/workflows/markdown-lint.yml@v0.3.6
secrets: inherit

Default rules

The MD013 (line-length) rule is disabled by default to avoid failures in repositories with long lines. All other default markdownlint rules apply.

Customising rules

To override or extend the default rules, add a .markdownlint.json file at the root of your repository. markdownlint-cli picks this up automatically. Note that MD013 remains disabled by the workflow's --disable MD013 flag regardless of your config file.

Example .markdownlint.json to also disable the MD033 (inline HTML) rule:

{
  "MD013": false,
  "MD033": false
}