# Markdownlint

[**Markdownlint**](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.

You can enable the Markdownlint linter with:

```shell
trunk check enable markdownlint
```

## Auto Enabling

Markdownlint will be auto-enabled if any *Markdown* files are present.

## Settings

Markdownlint supports the following config files:

* `.markdownlint.json`
* `.markdownlint.yaml`
* `.markdownlint.yml`
* `.markdownlintrc`

You can move these files to `.trunk/configs` and `trunk check` will still find them. See [Moving Linters](https://docs.trunk.io/code-quality/overview/configure-linters#moving-linters) for more info. Trunk Code Quality provides a default `.markdownlint.yaml` if your project does not already have one.

## Usage Notes

Older versions of `markdownlint` had a bug where it printed plaintext output even when run with `--json`. We rely on JSON output so we can parse and ingest the results from markdownlint. The package we use for markdownlint is actually [markdownlint-cli ](https://www.npmjs.com/package/markdownlint-cli)`>= 0.29.0` is verified to work.

## Links

* [Markdownlint site](https://github.com/DavidAnson/markdownlint)
* Markdownlint Trunk Code Quality [integration source](https://github.com/trunk-io/plugins/tree/main/linters/markdownlint)
* Trunk Code Quality's [open source plugins repo](https://github.com/trunk-io/plugins/tree/main)