woodpecker/markdownlint
woodpecker/markdownlint
6
0
Fork 0
Code Issues 1 Pull requests 1 Activity
A WoodpeckerCI plugin for markdownlint-cli to lint markdown files. https://hub.docker.com/r/kokuwaio/markdownlint
68 commits 2 branches 0 tags 121 KiB
  • Dockerfile 80.3%
  • Shell 19.7%
Find a file
Exact
Renovate d87ad58af5
All checks were successful
ci/woodpecker/pr/lint Pipeline was successful
Details
ci/woodpecker/push/lint Pipeline was successful
Details
chore(deps): update kokuwaio/markdownlint docker tag from 0.47.0 to 0.48.0
2026-03-03 09:05:04 +00:00
.github chore: aligned build files with other repositories 2025-08-01 08:25:56 +02:00
.woodpecker chore(deps): update kokuwaio/markdownlint docker tag from 0.47.0 to 0.48.0 2026-03-03 09:05:04 +00:00
.justfile chore: add version to readme 2025-09-29 09:29:44 +02:00
.markdownlint.yaml Initial draft of plugin. 2025-06-17 22:47:27 +02:00
.yamllint.yaml chore: aligned build files with other repositories 2025-08-01 08:25:56 +02:00
Dockerfile chore(deps): update dependency markdownlint-cli from 0.47.0 to 0.48.0 2026-03-03 06:07:16 +00:00
Dockerfile.dockerignore Initial draft of plugin. 2025-06-17 22:47:27 +02:00
entrypoint.sh Initial draft of plugin. 2025-06-17 22:47:27 +02:00
LICENSE Initial draft of plugin. 2025-06-17 22:47:27 +02:00
README.md chore(deps): update dependency markdownlint-cli from 0.47.0 to 0.48.0 2026-03-03 06:07:16 +00:00
renovate.json chore: add version to readme 2025-09-29 09:29:44 +02:00

README.md

Markdownlint WoodpeckerCI Plugin

pulls size dockerfile license prs issues

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:
    depends_on: []
    image: kokuwaio/markdownlint:0.48.0
    settings:
      dot: true
      enable: [MD013, MD041]
    when:
      event: pull_request
      path: [.markdownlint.yaml, "**/*.md"]]

Gitlab: (using script is needed because of https://gitlab.com/gitlab-org/gitlab/-/issues/19717)

markdownlint:
  needs: []
  stage: lint
  image:
    name: kokuwaio/markdownlint:0.48.0
    entrypoint: [""]
  script: [/usr/local/bin/entrypoint.sh]
  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):rw --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 size size
ghcr.io/igorshubovych/markdownlint-cli not a Woodpecker plugin, official size size
tmknom/markdownlint not a Woodpecker plugin size size
thegeeklab/markdownlint-cli not a Woodpecker plugin size size
peterdavehello/markdownlint not a Woodpecker plugin size size
06kellyjac/markdownlint-cli not a Woodpecker plugin, outdated size size