Skip to content

remark preset to configure remark-lint with markdown style conventions

License

Notifications You must be signed in to change notification settings

form8ion/remark-lint-preset

Repository files navigation

remark-lint-preset

remark preset to configure remark-lint with markdown style conventions

Node CI Workflow Status

Usage

npm MIT license node

Installation

$ npm install remark remark-cli @form8ion/remark-lint-preset --save-dev

Configure

Add to the project's .remarkrc.js:

export default {plugins: ['@form8ion/remark-lint-preset']};

Add an npm script that will run as part of npm test:

    "lint:md": "remark --frail ."

Contributing

Conventional Commits Commitizen friendly semantic-release PRs Welcome Renovate

Dependencies

$ nvm install
$ npm install

Verification

$ npm test