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/github-action-markdown-cli@v3.0.1
  with:
    files: .
    config: .markdownlint.yaml
    disable: MD013 MD041
    dot: true
    enable: MD013 MD041
    ignore: examples/ignore/*
    ignore_path: examples/.markdownlintignore
    rules: examples/rules/custom.js

• files - what to process (files, directories, globs)
• config (optional) - configuration file (JSON or YAML)
• disable (optional) - disable certain rules, for example MD013 MD041
• dot (optional) - if true, include files/folders with a dot (for example .github)
• enable (optional) - enable certain rules, for example MD013 MD041
• ignore (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)

These inputs are still available but will be removed in a future major version.

• config_file (optional) - configuration file (JSON or YAML) - superseded by config
• ignore_files (optional) - files to ignore/exclude (file, directory, glob) - superseded by ignore

The scripts and documentation in this project are released under the MIT License.