@lehoczky/markdownlint-define-config/README.md

Provide a defineConfig function for .markdownlint.js files

# markdownlint-define-config

[![NPM version](https://img.shields.io/npm/v/@lehoczky/markdownlint-define-config.svg)](https://www.npmjs.com/package/@lehoczky/markdownlint-define-config)

Provide a `defineMarkdownlintConfig()` function for [markdownlint](https://github.com/DavidAnson/markdownlint) configuration files. Inspired by vite's [defineConfig](https://vitejs.dev/config/#config-intellisense) and [eslint-define-config](https://github.com/Shinigami92/eslint-define-config).

With `defineMarkdownlintConfig()` you can have type checking, documentation, deprecation warnings, and autocompletion support directly in your `.markdownlint.js` file:

![autocomplete](docs/assets/autocomplete.png)

![documentation](docs/assets/jsdoc.png)

## 💿 Installation

```sh
# add markdownlint-cli2 and markdownlint-define-config to project’s dev dependencies
npm add --save-dev markdownlint-cli2 @lehoczky/markdownlint-define-config
# or
yarn add --dev markdownlint-cli2 @lehoczky/markdownlint-define-config
# or
pnpm add --save-dev markdownlint-cli2 @lehoczky/markdownlint-define-config
```

## 💻 Usage

In your `.markdownlint.js`:

<!-- prettier-ignore-start -->

```js
// @ts-check
const { defineMarkdownlintConfig } = require("@lehoczky/markdownlint-define-config")

module.exports = defineMarkdownlintConfig({
  // rules...
})
```

<!-- prettier-ignore-end -->