@vapurrmaid/md-config

This package installs an opinionated markdownlint configuration for markdown files.

What's Included

• .markdownlint.json configuration
• markdownlint-cli package
• lint:md script added to package.json

Installation

NPX (preferred)

Use the following command to install the contents in the current directory.

npx @vapurrmaid/md-config

Yarn or NPM

The following installs an executable in node_modules:

# yarn
yarn add -D @vapurrmaid/md-config

# npm
npm install --save-dev @vapurrmaid/md-config

From there, you must run the executable to install in the current directory:

./node_modules/.bin/md-config

Contributions

While I'm an open-source contributor and love collaboration, I use these configurations in my personal/hobby projects. Therefore, I'm generally not accepting contributions outside of security-related concerns. Please feel free to fork your own version or use these configurations.