Have ideas to improve npm?Join in the discussion! »

    breakdance-reflinks

    0.1.4 • Public • Published

    breakdance-reflinks NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of the file as reference links.

    Install

    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.

    Usage

    Use breakdance's .before method to register the plugin.

    var Breakdance = require('breakdance');
     
    // IMPORTANT! you must enable reflinks. You can do 
    // that here or on the `.render` method
    var breakdance = new Breakdance({reflinks: true});
    var reflinks = require('breakdance-reflinks');
     
    // this adds a 
    breakdance.before('eos', reflinks());
     
    // after registering the plugin, use the `.render` method
    // to convert HTML to markdown
    var markdown = breakdance.render(/* html string */);
    console.log(markdown);

    Visit the breakdance documentation for more information about using and customizing breakdance.

    About

    Related projects

    Contributing

    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.

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ 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:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. MIT


    This file was generated by verb-generate-readme, v0.4.2, on February 15, 2017.

    Install

    npm i breakdance-reflinks

    DownloadsWeekly Downloads

    6

    Version

    0.1.4

    License

    MIT

    Last publish

    Collaborators

    • avatar