Skip to content
Style checking and linting for Markdown/CommonMark files.
Shell Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
examples
.markdownlintrc
Dockerfile
LICENSE
README.md
action.yml
entrypoint.sh

README.md

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/github-action-markdown-cli@v1.1
        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.

You can’t perform that action at this time.