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

v1 Pre-release

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@v1
Learn more about this action in nosborn/github-action-markdown-cli

Choose a version

github-action-markdownlint-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:
          config_file: ".markdownlint.yaml"
          files: .
          ignore_files: "examples/ignore/*"
          rules: "examples/rules/custom.js"

Inputs

  • config_file - configuration file (JSON or YAML)
  • files - what to process, this is required - files, directories, globs
  • ignore_files - files to ignore/exclude - file, directory, glob
  • rules - custom rule files - file, directory, glob, package

License

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