# breakdance > 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. Latest version **3.0.1** (published 2017-05-13) · MIT license · 0 weekly downloads ## Install ```sh npm install breakdance pnpm add breakdance yarn add breakdance bun add breakdance ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 3.0.1 | | Published | 2017-05-13 | | First published | 2017-02-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=4.0 | | Dependencies | 19 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 539 | | Author | Jon Schlinkert | | Maintainers | jonschlinkert | | Keywords | breakdance, convert, format, html, markdown, parse, plain text, re-format, render, text, to-markdown, tomd | ## Links - npm: https://www.npmjs.com/package/breakdance - Repository: https://github.com/breakdance/breakdance - Homepage: http://breakdance.io - Issues: https://github.com/breakdance/breakdance/issues - npm.io page: https://npm.io/package/breakdance ## Dependencies (19) - [cheerio](https://npm.io/package/cheerio.md) ^0.22.0 - [isobject](https://npm.io/package/isobject.md) ^3.0.0 - [unescape](https://npm.io/package/unescape.md) ^0.2.0 - [mixin-deep](https://npm.io/package/mixin-deep.md) ^1.2.0 - [snapdragon](https://npm.io/package/snapdragon.md) ^0.11.0 - [export-files](https://npm.io/package/export-files.md) ^2.1.1 - [detect-indent](https://npm.io/package/detect-indent.md) ^5.0.0 - [repeat-string](https://npm.io/package/repeat-string.md) ^1.6.1 - [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1 - [breakdance-util](https://npm.io/package/breakdance-util.md) ^0.1.5 - [define-property](https://npm.io/package/define-property.md) ^1.0.0 - [is-self-closing](https://npm.io/package/is-self-closing.md) ^1.0.0 - [snapdragon-node](https://npm.io/package/snapdragon-node.md) ^1.0.6 - [snapdragon-util](https://npm.io/package/snapdragon-util.md) ^2.1.1 - [strip-attributes](https://npm.io/package/strip-attributes.md) ^0.2.0 - [condense-newlines](https://npm.io/package/condense-newlines.md) ^0.2.1 - [snapdragon-cheerio](https://npm.io/package/snapdragon-cheerio.md) ^1.1.0 - [trim-leading-lines](https://npm.io/package/trim-leading-lines.md) ^0.1.1 - [trim-trailing-lines](https://npm.io/package/trim-trailing-lines.md) ^1.1.0 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 3.0.1 (latest) — 2017-05-13 - 4.0.0-alpha (alpha) — 2026-01-05 - 3.0.0 — 2017-05-13 - 2.0.0 — 2017-04-25 - 1.1.0 — 2017-04-22 - 1.0.0 — 2017-03-12 - 0.2.0 — 2017-02-15 - 0.1.7 — 2017-02-15 - 0.1.6 — 2017-02-09 - 0.1.5 — 2017-02-05 - 0.1.4 — 2017-02-05 - 0.1.3 — 2017-02-01 - 0.1.2 — 2017-02-01 - 0.1.1 — 2017-02-01 - 0.1.0 — 2017-02-01 ## README # breakdance [![NPM version](https://img.shields.io/npm/v/breakdance.svg?style=flat)](https://www.npmjs.com/package/breakdance) [![NPM monthly downloads](https://img.shields.io/npm/dm/breakdance.svg?style=flat)](https://npmjs.org/package/breakdance) [![NPM total downloads](https://img.shields.io/npm/dt/breakdance.svg?style=flat)](https://npmjs.org/package/breakdance) [![Build Status](https://img.shields.io/travis/breakdance/breakdance.svg?style=flat)](https://travis-ci.org/breakdance/breakdance) > 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. Breakdance is a node.js library for converting HTML to markdown. You can use breakdance to: * Migrate HTML blog posts to markdown * Convert wiki pages to markdown * Convert HTML documentation to markdown * Convert HTML presentations or slide decks to markdown * Convert busy web pages into readable markdown documents. Visit [breakdance.io](http://breakdance.io) for detailed documentation, [examples](http://breakdance.io/examples), [recipes](http://breakdance.io/recipes), and advice on [authoring and finding plugins](http://breakdance.io/plugins.html). ## Why should I use breakdance? Breakdance uses [cheerio](https://github.com/cheeriojs/cheerio) to parse HTML, and [snapdragon](https://github.com/jonschlinkert/snapdragon) for rendering, which provides granular control over the entire conversion process in a way that is easy to understand, reason about, and [customize](http://breakdance.io/plugins.html). If you see something you don't like, it's easy to change! **Generates well-formatted markdown** * Comprehensive [HTML tag coverage](lib/compiler.js). * Granular control over every HTML element and attributes * Even **converts HTML tables** to markdown! **Extremely pluggable** Every part of the conversion is customizable: * [options](http://breakdance.io/plugins.html) are available for customizing output of any HTML tag if you don't like the defaults * [plugins](http://breakdance.io/plugins.html) are easy to write if you'd like to share your customizations with the world ## HTML-to-markdown example **Tables** The following HTML table from [bootstrap's docs](https://github.com/twbs/bootstrap): ```html

Hover rows

Add .table-hover to enable a hover state on table rows within a <tbody>.

# First Name Last Name Username
1 Mark Otto @mdo
2 Jacob Thornton @fat
3 Larry the Bird @twitter
``` Would render to the following markdown: ``` ## Hover rows Add `.table-hover` to enable a hover state on table rows within a ``. | # | First Name | Last Name | Username | | --- | --- | --- | --- | | 1 | Mark | Otto | @mdo | | 2 | Jacob | Thornton | @fat | | 3 | Larry | the Bird | @twitter | ``` See [the documentation](http://breakdance.io/examples.html) for more examples. ## About ### Community Get updates on Breakdance's development and chat with the project maintainers and community members. * Follow [@breakdancejs on Twitter](https://twitter.com/breakdancejs). * Join the [conversation on Gitter](https://gitter.im/breakdance/breakdance?utm_source=share-link&utm_medium=link&utm_campaign=share-link) * Implementation help may be found on Stack Overflow (please use the tag [breakdance](https://stackoverflow.com/questions/tagged/breakdance)`breakdance`). * For maximum discoverability, plugin developers should use the keyword `breakdance` on packages which modify or add to the functionality of Breakdance when distributing through [npm](https://www.npmjs.com/browse/keyword/breakdance) or similar delivery mechanisms. ### Related projects * [breakdance-checklist](https://www.npmjs.com/package/breakdance-checklist): Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown. | [homepage](https://github.com/breakdance/breakdance-checklist "Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown.") * [breakdance-reflinks](https://www.npmjs.com/package/breakdance-reflinks): Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of… [more](https://github.com/breakdance/breakdance-reflinks) | [homepage](https://github.com/breakdance/breakdance-reflinks "Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of the file as reference links.") * [breakdance-util](https://www.npmjs.com/package/breakdance-util): Utility functions for breakdance plugins. | [homepage](https://github.com/breakdance/breakdance-util "Utility functions for breakdance plugins.") ### 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. ### Contributors | **Commits** | **Contributor** | | --- | --- | | 118 | [jonschlinkert](https://github.com/jonschlinkert) | | 3 | [doowb](https://github.com/doowb) | | 1 | [davidbgk](https://github.com/davidbgk) | ### Release history Changelog entries are classified using the following labels from [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog): * `added`: for new features * `changed`: for changes in existing functionality * `deprecated`: for once-stable features removed in upcoming releases * `removed`: for deprecated features removed in this release * `fixed`: for any bug fixes Custom labels used in this changelog: * `dependencies`: bumps dependencies * `housekeeping`: code re-organization, minor edits, or other changes that don't fit in one of the other categories. ##### [3.0.0](https://github.com/breakdance/breakdance/compare/2.0.0...3.0.0) - 2017-05-12 **Removed** * CLI was externalized to [breakdance-cli][] ##### [2.0.0](https://github.com/breakdance/breakdance/compare/1.1.0...2.0.0) - 2017-04-25 **Changed** * ``: now renders as `**bold**`, same as `` tags * ``: now renders as `_italics_`, same as `` tags ##### [1.1.0](https://github.com/breakdance/breakdance/compare/1.0.0...1.1.0) - 2017-04-21 **Fixed** * ``: improvements to whitespace handling * ``: no longer renders empty tags * `

`: normalize Unicode `U+00A0` non-breaking spaces to "normal" Unicode `U+0020` spaces. Non-breaking spaces are useful in HTML, but cause flow problems in markdown. **Added** * documentation for `options.comments`, `options.unsmarty`, `options.trailingWhitespace`, all previously undocumented options. See [breakdance.io/options](http://breakdance.io/docs.html#options) ##### [1.0.0](https://github.com/breakdance/breakdance/compare/0.1.5...1.0.0) - 2017-03-12 **Added** * Adds support for ``, closes [issue #3](https://github.com/breakdance/breakdance/issues/3) **Changed** * Changed the CLI command from `tomd` to either `br`. As a fallback, you can also use `breakdance` if there is a conflict. The CLI has not yet been documented, so hopefully this doesn't cause any issues for anyone. ##### [0.1.5](https://github.com/breakdance/breakdance/compare/0.1.4...0.1.5) **Fixed** * An extra trailing newline was being added on `` tags **Added** * Adds `keepEmpty` option, to selective keep empty tags that are omitted by built-in `omitEmpty` tags * Adds documentation for `omit`, `pick` and `omitEmpty` and `keepEmpty` options **Changed** * Externalized `utils.js` to [breakdance-util](https://github.com/breakdance/breakdance-util), to allow plugin authors to use the same utilities as breakdance, for consistency. ##### [0.1.4](https://github.com/breakdance/breakdance/compare/0.1.0...0.1.4) **Fixed** * Better whitespace handling in `table`, `a` and `dl` tags **Added** * Adds documentation for `url` option ##### [0.1.0] First release. _(Changelog generated by [helper-changelog](https://github.com/helpers/helper-changelog))_ ### 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.5.0, on May 12, 2017._ --- _Source: https://npm.io/package/breakdance · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._