github-action-markdown-cli

A GitHub Action that performs style checking and linting for Markdown/CommonMark files using markdownlint-cli.

Usage

Basic usage with all options enabled:

- name: markdownlint-cli
  uses: nosborn/[email protected]
  with:
    files: .
    config_file: .markdownlint.yaml
    dot: true
    ignore_files: examples/ignore/*
    ignore_path: examples/.markdownlintignore
    rules: examples/rules/custom.js

Inputs

• files - what to process (files, directories, globs)
• config_file (optional) - configuration file (JSON or YAML)
• dot (optional) - include files/folders with a dot (for example .github)
• 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)

License

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