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:
config_file: ".markdownlint.yaml"
files: .
ignore_files: "examples/ignore/*"
rules: "examples/rules/custom.js"
config_file- configuration file (JSON or YAML)files- what to process, this is required - files, directories, globsignore_files- files to ignore/exclude - file, directory, globrules- custom rule files - file, directory, glob, package
The scripts and documentation in this project are released under the MIT License.