Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 3.25 KB

README.md

File metadata and controls

77 lines (47 loc) · 3.25 KB

gulp-breakdance NPM version NPM monthly downloads NPM total downloads Linux Build Status

Gulp plugin for breakdance, the HTML-to-markdown converter for node.js.

Install

Install with npm:

$ npm install --save gulp-breakdance

Heads up!

Please report all bugs related to HTML-to-markdown conversion on the breakdance issue tracker.

Usage

Visit breakdance.io for all available features and options.

var breakdance = require('gulp-breakdance');

gulp.task('breakdance', function() {
  return gulp.src('foo/*.html')
    .pipe(breakdance([options]))
    .pipe(gulp.dest('bar'));
});

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on June 04, 2017.