README.md

Remark Config

Remark preset to configure remark-lint with settings that inherit from remark-preset-lint-markdown-style-guide with some customization for usage at TELUS.

Usage

1. Install

npm install --save-dev remark-cli @telus/remark-config

2. Configure

include a .remarkrc file in your project root directory:

{
  "plugins": [
    "@telus/remark-config"
  ]
}

3. Run

remark --quiet --frail .

4. Add to your npm scripts (recommended)

"scripts": {
  "lint:markdown": "remark --quiet --frail ."
  ...
}

---

Github: @telus • Twitter: @telusdigital