Markdownlint Plugin

A Woodpecker CI plugin for markdownlint-cli to lint markdown files.
Also usable with Gitlab, Github or locally, see examples for usage.

Features

• preconfigure markdownlint-cli parameters
• searches for markdown files recursive
• runnable with local docker daemon

Example

Woodpecker:

steps:
  markdownlint:
    image: kokuwaio/markdownlint
    depends_on: []
    settings:
      dot: true
      enable: [MD013, MD041]
    when:
      event: pull_request
      path: [.markdownlint.yaml, "**/*.md"]]

Gitlab:

markdownlint:
  stage: lint
  needs: []
  image: kokuwaio/markdownlint
  variables:
    PLUGIN_DOT: true
    PLUGIN_ENABLE: MD013,MD041
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: [.markdownlint.yaml, "**/*.md"]

CLI:

docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/markdownlint --fix

Settings

Settings Name	Environment	Default	Description
config-file	PLUGIN_CONFIG_FILE	none	Configuration file (JSON, JSONC, JS, YAML, or TOML)
dot	PLUGIN_DOT	true	Include files/folders with a dot (for example .github)
enable	PLUGIN_ENABLE	none	Enable certain rules, e.g. --enable=MD013,MD041
disable	PLUGIN_DISABLE	none	Disable certain rules, e.g. --disable=MD013,MD041

Alternatives

Image	Comment	amd64	arm64
kokuwaio/markdownlint	Woodpecker plugin
ghcr.io/igorshubovych/markdownlint-cli	not a Woodpecker plugin, official
tmknom/markdownlint	not a Woodpecker plugin
thegeeklab/markdownlint-cli	not a Woodpecker plugin
peterdavehello/markdownlint	not a Woodpecker plugin
06kellyjac/markdownlint-cli	not a Woodpecker plugin, outdated