Akmon mirror of nosborn/github-action-markdown-cli (code only; Actions unit OFF).

Shell 71.4%
Dockerfile 28.6%

Find a file

dependabot[bot] 1a79194d2c Chore(deps): bump node from `2867d55` to `682368d` Bumps node from `2867d55` to `682368d`. --- updated-dependencies: - dependency-name: node dependency-version: lts-alpine dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>		2025-12-13 07:36:27 +00:00
.github	Chore(deps): bump actions/checkout from 6.0.0 to 6.0.1	2025-12-13 07:32:32 +00:00
examples	Expose --ignore-path option	2021-12-20 13:18:52 +08:00
.dockerignore	Make problem matcher available to published action	2021-12-21 09:01:22 +08:00
.gitattributes	Reproducible npm build	2025-06-12 14:44:46 +08:00
.gitignore	Reproducible npm build	2025-06-12 14:44:46 +08:00
.markdownlintrc	Initial commit	2019-11-03 13:59:27 +08:00
.pre-commit-config.yaml	Reproducible npm build	2025-06-12 14:44:46 +08:00
.yamllint	chore: bump/pin actions	2023-03-30 00:13:18 +08:00
action.yml	Expose --dot option	2022-09-22 21:44:33 +08:00
Dockerfile	Chore(deps): bump node from `2867d55` to `682368d`	2025-12-13 07:36:27 +00:00
entrypoint.sh	Reproducible npm build	2025-06-12 14:44:46 +08:00
LICENSE	chore: update copyright years	2025-06-12 10:57:04 +08:00
markdownlint-problem-matcher.json	Make problem matcher available to published action	2021-12-21 09:01:22 +08:00
package-lock.json	Chore(deps): bump js-yaml from 4.1.0 to 4.1.1	2025-11-21 06:06:36 +00:00
package.json	Bump version to v3.5.0	2025-06-12 18:25:33 +08:00
README.md	Bump version to v3.5.0	2025-06-12 18:25:33 +08:00
SECURITY.md	Publish a security policy	2025-06-12 13:37:47 +08:00

README.md

github-action-markdown-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@v3.5.0
  with:
    files: .
    config_file: .markdownlint.yaml
    dot: true
    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)
dot (optional) - include files/folders with a dot (for example .github)
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.