Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of the file as reference links.
Install with npm:
$ npm install --save breakdance-reflinks
This is a plugin for breakdance, the HTML-to-markdown converter.
What does this do?
Moves URLs to the bottom of the rendered markdown document, and replaces them with numbered "placeholder" reference links.
This has both advantages and disadvantages, depending on your needs.
- advantage: this can make the markdown more readable
- disadvantage: the downside is that the "placeholder" URLs are numbered, so it won't be immediately clear to readers what the actual URL is until they visit the corresponding reference link at the bottom of the document.
.before method to register the plugin.
var Breakdance = ;// IMPORTANT! you must enable reflinks. You can do// that here or on the `.render` methodvar breakdance = reflinks: true;var reflinks = ;// this adds abreakdance;// after registering the plugin, use the `.render` method// to convert HTML to markdownvar markdown = breakdance;console;
Visit the breakdance documentation for more information about using and customizing breakdance.
- breakdance-checklist: Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown. | homepage
- breakdance-util: Utility functions for breakdance plugins. | homepage
- breakdance: Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy… more | homepage
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.
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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
Copyright © 2017, Jon Schlinkert. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 15, 2017.