# hs-markdownlint-cli

> HS MarkdownLint Command Line Interface

Latest version **0.1.2** (published 2019-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install hs-markdownlint-cli
pnpm add hs-markdownlint-cli
yarn add hs-markdownlint-cli
bun add hs-markdownlint-cli
```

Provides the command `markdownlint`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2019-05-20 |
| First published | 2019-05-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 10 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kun Chen |
| Maintainers | quentinchen |
| Keywords | markdown, markdownlint, cli, cli-app |

## Links

- npm: https://www.npmjs.com/package/hs-markdownlint-cli
- Repository: https://github.com/kchen0x/markdownlint-cli
- Homepage: https://github.com/kchen0x/markdownlint-cli#readme
- Issues: https://github.com/kchen0x/markdownlint-cli/issues
- npm.io page: https://npm.io/package/hs-markdownlint-cli

## Dependencies (10)

- [rc](https://npm.io/package/rc.md) ~1.2.7
- [glob](https://npm.io/package/glob.md) ~7.1.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [commander](https://npm.io/package/commander.md) ~2.9.0
- [get-stdin](https://npm.io/package/get-stdin.md) ~5.0.1
- [minimatch](https://npm.io/package/minimatch.md) ~3.0.4
- [deep-extend](https://npm.io/package/deep-extend.md) ~0.5.1
- [markdownlint](https://npm.io/package/markdownlint.md) ~0.14.1
- [lodash.flatten](https://npm.io/package/lodash.flatten.md) ~4.4.0
- [lodash.differencewith](https://npm.io/package/lodash.differencewith.md) ~4.5.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2019-05-20
- 0.1.1 — 2019-05-20
- 0.1.0 — 2019-05-20

## README

# markdownlint-cli [![Travis CI Build Status][travis-badge]][travis-url] [![AppVeyor CI Build Status][appveyor-badge]][appveyor-url]

> Command Line Interface for [MarkdownLint][markdownlint]

## Installation

```bash
npm install -g markdownlint-cli
```

## Usage

```bash
$ markdownlint --help

  Usage: markdownlint [options] <files|directories|globs>

  MarkdownLint Command Line Interface

  Options:

    -h, --help                                  output usage information
    -V, --version                               output the version number
    -s, --stdin                                 read from STDIN (no files)
    -o, --output [outputFile]                   write issues to file (no console)
    -c, --config [configFile]                   configuration file (JSON or YAML)
    -i, --ignore [file|directory|glob]          files to ignore/exclude
    -r, --rules  [file|directory|glob|package]  custom rule files
```

## Configuration

`markdownlint-cli` reuses [the rules][rules] from `markdownlint` package.

Configuration is stored in JSON, YAML or INI files in the same [config format][config].

The example of configuration file:

```json
{
  "default": true,
  "MD003": { "style": "atx_closed" },
  "MD007": { "indent": 4 },
  "no-hard-tabs": false,
  "whitespace": false
}
```

See [test configuration file][test-config] or [style folder][style-folder] for more examples.

CLI argument `--config` is not mandatory. If it is not provided, `markdownlint-cli` looks for file `.markdownlint.json`/`.markdownlint.yaml`/`.markdownlint.yml` in current folder, or for file `.markdownlintrc` in current or all upper folders. The algorithm is described in details on [rc package page][rc-standards]. If `--config` argument is provided, the file must be valid JSON or YAML.

## Related

- [markdownlint][markdownlint] - API for this module
- [glob][glob] - Pattern matching implementation

## License

MIT © Igor Shubovych

[travis-badge]: https://img.shields.io/travis/igorshubovych/markdownlint-cli/master.svg?label=linux
[travis-url]: https://travis-ci.org/igorshubovych/markdownlint-cli

[appveyor-badge]: https://img.shields.io/appveyor/ci/igorshubovych/markdownlint-cli/master.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/igorshubovych/markdownlint-cli

[markdownlint]: https://github.com/DavidAnson/markdownlint
[rules]: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md
[config]: https://github.com/DavidAnson/markdownlint#optionsconfig
[style-folder]: https://github.com/DavidAnson/markdownlint/tree/master/style
[test-config]: https://github.com/igorshubovych/markdownlint-cli/blob/master/test/test-config.json
[rc-standards]: https://www.npmjs.com/package/rc#standards
[glob]: https://github.com/isaacs/node-glob

---
_Source: https://npm.io/package/hs-markdownlint-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._