https://github.com/breakdance/gulp-breakdance
Gulp plugin for breakdance, the HTML-to-markdown converter for node.js.
https://github.com/breakdance/gulp-breakdance
conversion convert converter html html-to-markdown html-to-md markdown markup md to-markdown to-md
Last synced: about 1 year ago
JSON representation
Gulp plugin for breakdance, the HTML-to-markdown converter for node.js.
- Host: GitHub
- URL: https://github.com/breakdance/gulp-breakdance
- Owner: breakdance
- License: mit
- Created: 2017-06-04T11:39:46.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-04T11:44:18.000Z (about 9 years ago)
- Last Synced: 2025-04-15T11:47:01.402Z (about 1 year ago)
- Topics: conversion, convert, converter, html, html-to-markdown, html-to-md, markdown, markup, md, to-markdown, to-md
- Language: JavaScript
- Homepage: http://breakdance.io
- Size: 15.6 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-breakdance [](https://www.npmjs.com/package/gulp-breakdance) [](https://npmjs.org/package/gulp-breakdance) [](https://npmjs.org/package/gulp-breakdance) [](https://travis-ci.org/breakdance/gulp-breakdance)
> Gulp plugin for breakdance, the HTML-to-markdown converter for node.js.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save gulp-breakdance
```
## Heads up!
Please report all bugs related to HTML-to-markdown conversion on the [breakdance issue tracker](https://github.com/breakdance/breakdance/issues).
## Usage
Visit [breakdance.io](http://breakdance.io) for all available features and options.
```js
var breakdance = require('gulp-breakdance');
gulp.task('breakdance', function() {
return gulp.src('foo/*.html')
.pipe(breakdance([options]))
.pipe(gulp.dest('bar'));
});
```
## About
### Related projects
* [breakdance](https://www.npmjs.com/package/breakdance): Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy… [more](http://breakdance.io) | [homepage](http://breakdance.io "Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy to use. It's time for your markup to get down.")
* [gulp-html-toc](https://www.npmjs.com/package/gulp-html-toc): Gulp plugin for html-toc, for generating a HTML table of contents. | [homepage](https://github.com/jonschlinkert/gulp-html-toc "Gulp plugin for html-toc, for generating a HTML table of contents.")
* [gulp-htmlmin](https://www.npmjs.com/package/gulp-htmlmin): gulp plugin to minify HTML. | [homepage](https://github.com/jonschlinkert/gulp-htmlmin#readme "gulp plugin to minify HTML.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 04, 2017._