Skip to content
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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@v3.0.1
        with:
          files: .
          config_file: .markdownlint.yaml
          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)
  • 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.