Gulp task - lint markdown using remark-lint
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
index.js
package.json
screenshot.png

README.md

gulp-remark-lint-dko

Deprecated in favor of vfile-to-eslint

Gulp task using remark and remark-lint to lint markdown files and output stylish results

Example output

Install

$ npm install --save-dev gulp-remark-lint-dko

Usage

Outputs results to stdout.

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

License

MIT © David O'Trakoun