README
Remark Config
remark preset to configure
remark-lint
with settings that inherit fromremark-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 .
npm scripts
(recommended)
4. Add to your "scripts": {
"lint:markdown": "remark --quiet --frail ."
...
}
Github: @telus • Twitter: @telusdigital