https://github.com/breakdance/breakdance-cli
CLI for breakdance, the HTML to markdown converter for node.js.
https://github.com/breakdance/breakdance-cli
breakdance cheerio cli command-line convert html markdown snapdragon
Last synced: 3 months ago
JSON representation
CLI for breakdance, the HTML to markdown converter for node.js.
- Host: GitHub
- URL: https://github.com/breakdance/breakdance-cli
- Owner: breakdance
- License: mit
- Created: 2017-05-13T02:45:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-25T16:33:54.000Z (over 8 years ago)
- Last Synced: 2025-05-17T00:54:54.851Z (5 months ago)
- Topics: breakdance, cheerio, cli, command-line, convert, html, markdown, snapdragon
- Language: JavaScript
- Homepage: http://breakdance.io
- Size: 8.79 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# breakdance-cli [](https://www.npmjs.com/package/breakdance-cli) [](https://npmjs.org/package/breakdance-cli) [](https://npmjs.org/package/breakdance-cli)
> CLI for breakdance, the HTML to markdown converter for node.js.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save breakdance-cli
```
## Getting started
If you want to see how breakdance works, the CLI is the fastest way to get started.
### Installing the CLI
Install the breakdance CLI with [npm](https://www.npmjs.com/):
```sh
$ npm install --global breakdance-cli
```
This adds the `bd` command to your system path, allowing you to run the breakdance CLI from any directory.
```sh
$ bd
# also aliased as "breakdance" in case of conflicts
$ breakdance
```
See the [breakdance documentation](http://breakdance.io/docs.html#getting-started) for more information about usage and options.
## About
### 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 May 12, 2017._