Skip to content
check-circle

GitHub Action

markdown-lint

v1.1.0 Latest version

markdown-lint

check-circle

markdown-lint

Lint your markdown

Installation

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

              

- name: markdown-lint

uses: articulate/actions-markdownlint@v1.1.0

Learn more about this action in articulate/actions-markdownlint

Choose a version

markdownlint action

This action lints your Markdown files with markdownlint-cli.

Usage

Including the action without any defaults will find a local markdownlint config file (.markdownlint.{yaml,yml,json}) or use our included default and scan all files with the md or markdown extension.

- uses: articulate/actions-markdownlint@v1

You can set the config file, the files it scans, or files/directories to ignore.

- uses: articulate/actions-markdownlint@v1
  with:
    config: markdownlint-config.json
    files: 'docs/**/*.md'
    ignore: node_modules