You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
markdownlint-cli
v3.0.0
A GitHub Action that performs style checking and linting for Markdown/CommonMark files using markdownlint-cli.
Basic usage with all options enabled:
- name: markdownlint-cli
uses: nosborn/[email protected]
with:
files: .
config_file: .markdownlint.yaml
ignore_files: examples/ignore/*
ignore_path: examples/.markdownlintignore
rules: examples/rules/custom.js
files
- what to process (files, directories, globs)config_file
(optional) - configuration file (JSON or YAML)ignore_files
(optional) - files to ignore/exclude (file, directory, glob)ignore_path
(optional) - path to file with ignore pattern(s)rules
(optional) - custom rule files (file, directory, glob, package)
The scripts and documentation in this project are released under the MIT License.