Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check-circle

GitHub Action

markdownlint-cli

v2.0.0

markdownlint-cli

check-circle

markdownlint-cli

Style checker and lint tool for Markdown/CommonMark files

Installation

Copy and paste the following snippet into your .yml file.

              

- name: markdownlint-cli

uses: nosborn/github-action-markdown-cli@v2.0.0

Learn more about this action in nosborn/github-action-markdown-cli

Choose a version

github-action-markdown-cli

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

CI Workflow Status Release Workflow Status

Usage

Basic usage with all options enabled:

      - name: markdownlint-cli
        uses: nosborn/github-action-markdown-cli@v2.0.0
        with:
          files: .
          config_file: ".markdownlint.yaml"
          ignore_files: "examples/ignore/*"
          rules: "examples/rules/custom.js"

Inputs

  • 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)
  • rules (optional) - custom rule files (file, directory, glob, package)

License

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