markdownlint-define-config
Provide a defineMarkdownlintConfig()
function for markdownlint configuration files. Inspired by vite's defineConfig and eslint-define-config.
With defineMarkdownlintConfig()
you can have type checking, documentation, deprecation warnings, and autocompletion support directly in your .markdownlint.js
file:
💿 Installation
# 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
:
// @ts-check
const { defineMarkdownlintConfig } = require("@lehoczky/markdownlint-define-config")
module.exports = defineMarkdownlintConfig({
// rules...
})