# remark-lint

[**remark-lint**](https://github.com/remarkjs/remark-lint#readme) is a linter for Markdown.

You can enable the remark-lint linter with:

```shell
trunk check enable remark-lint
```

## Auto Enabling

remark-lint will be auto-enabled if any of its config files are present: *`.remarkrc`, `.remarkrc.json`, `.remarkrc.cjs`*.

## Settings

remark-lint supports the following config files:

* `.remarkrc`
* `.remarkrc.json`
* `.remarkrc.cjs`
* `.remarkrc.mjs`
* `.remarkrc.js`
* `.remarkrc.yaml`
* `.remarkrc.yml`

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 `.remarkrc.yaml` if your project does not already have one.

## Links

* [remark-lint site](https://github.com/remarkjs/remark-lint#readme)
* remark-lint Trunk Code Quality [integration source](https://github.com/trunk-io/plugins/tree/main/linters/remark-lint)
* Trunk Code Quality's [open source plugins repo](https://github.com/trunk-io/plugins/tree/main)