kokuwaio/markdownlint
A WoodpeckerCI plugin for markdownlint-cli to lint markdown files.
Image
Integration & delivery
Developer tools
0
9.4K
kokuwaio/markdownlint repository overview
Markdownlint WoodpeckerCI 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:
depends_on: []
image: kokuwaio/markdownlint:0.49.1
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.49.1
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 |  |  |
| 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, outdated |  |  |
| 06kellyjac/markdownlint-cli | not a Woodpecker plugin, outdated |  |  |
Tag summary
Content type
Image
Digest
sha256:ac621cef0…
Size
78 MB
Last updated
7 days ago
docker pull kokuwaio/markdownlint