https://github.com/davidosomething/gulp-remark-lint-dko
Gulp task - lint markdown using remark-lint
https://github.com/davidosomething/gulp-remark-lint-dko
Last synced: 5 months ago
JSON representation
Gulp task - lint markdown using remark-lint
- Host: GitHub
- URL: https://github.com/davidosomething/gulp-remark-lint-dko
- Owner: davidosomething
- Created: 2016-01-23T02:03:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-05T00:21:08.000Z (almost 10 years ago)
- Last Synced: 2025-08-30T03:48:51.892Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gulp-remark-lint-dko
## Deprecated in favor of [vfile-to-eslint](https://github.com/sindresorhus/vfile-to-eslint)
> Gulp task using remark and remark-lint to lint markdown files and output
> stylish results
## Install
```
$ npm install --save-dev gulp-remark-lint-dko
```
## Usage
Outputs results to stdout.
```js
var gulp = require('gulp');
var lint = require('gulp-remark-lint-dko');
gulp.task('lintmarkdown', function () {
return gulp.src('md/**/*.md')
.pipe(lint({
rules: {
'definition-case': false,
'emphasis-marker': '_',
}
}))
.pipe(lint.report());
});
```
## Roadmap
New project! Pull requests welcome!
- [ ] gulp error on for invalid files and rule config
- [ ] read rules from remark config files (package.json, rc file)
- [ ] fail on error/warning
- [ ] output results to file
- [ ] tests, CI on travis and auto-npm-publish
- [ ] add addt'l options, e.g. support for [lint plugins](https://www.npmjs.com/package/remark-lint-code)
## License
MIT © [David O'Trakoun](http://davidosomething.com)