It's time for your markup to get down! HTML to markdown converter. Breakdance is a highly pluggable, flexible and easy to use.
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:
Visit our website for detailed documentation, examples, recipes, and advice on authoring and finding plugins.
Breakdance uses cheerio to parse HTML, and snapdragon for rendering, which provides granular control over the entire conversion process in a way that is easy to understand, reason about, and customize. If you see something you don't like, it's easy to change!
Generates well-formatted markdown
Extremely pluggable
Every part of the conversion is customizable:
Tables
The following HTML table from bootstrap's docs:
<h2 id=tables-hover-rows>Hover rows</h2>
<p>Add <code>.table-hover</code> to enable a hover state on table rows within a <code><tbody></code>.</p>
<div class=bs-example data-example-id=hoverable-table>
<table class="table table-hover">
<thead>
<tr>
<th>#</th>
<th>First Name</th>
<th>Last Name</th>
<th>Username</th>
</tr>
</thead>
<tbody>
<tr>
<th scope=row>1</th>
<td>Mark</td>
<td>Otto</td>
<td>@mdo</td>
</tr>
<tr>
<th scope=row>2</th>
<td>Jacob</td>
<td>Thornton</td>
<td>@fat</td>
</tr>
<tr>
<th scope=row>3</th>
<td>Larry</td>
<td>the Bird</td>
<td>@twitter</td>
</tr>
</tbody>
</table>
</div>
Would render to the following markdown:
## 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 |
See the documentation for more examples.
Get updates on Breakdance's development and chat with the project maintainers and community members.
breakdance
).breakdance
on packages which modify or add to the functionality of Breakdance when distributing through npm or similar delivery mechanisms.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.
Commits | Contributor |
---|---|
118 | jonschlinkert |
3 | doowb |
1 | davidbgk |
Changelog entries are classified using the following labels from keep-a-changelog:
added
: for new featureschanged
: for changes in existing functionalitydeprecated
: for once-stable features removed in upcoming releasesremoved
: for deprecated features removed in this releasefixed
: for any bug fixesCustom labels used in this changelog:
dependencies
: bumps dependencieshousekeeping
: code re-organization, minor edits, or other changes that don't fit in one of the other categories.Removed
Changed
<b>
: now renders as **bold**
, same as <strong>
tags<i>
: now renders as _italics_
, same as <em>
tagsFixed
<code>
: improvements to whitespace handling<code>
: no longer renders empty tags<p>
: 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
options.comments
, options.unsmarty
, options.trailingWhitespace
, all previously undocumented options. See breakdance's options
Added
<base>
, closes issue #3
Changed
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.Fixed
<code>
tagsAdded
keepEmpty
option, to selective keep empty tags that are omitted by built-in omitEmpty
tagsomit
, pick
and omitEmpty
and keepEmpty
optionsChanged
utils.js
to breakdance-util, to allow plugin authors to use the same utilities as breakdance, for consistency.Fixed
table
, a
and dl
tagsAdded
url
optionFirst release.
(Changelog generated by helper-changelog)
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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.5.0, on May 12, 2017.