Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 1.73 KB

.verb.md

File metadata and controls

64 lines (47 loc) · 1.73 KB
Raw

Usage

Add {%= name %} to your node.js application with the following line of JavaScript:

var mercury = require('{%= name %}');

API

{%= apidocs("index.js") %}

CLI

Installing the CLI

$ npm install  --global {%= name %}

This adds the bdm command to your system path, allowing you to run {%= name %} CLI from any directory:

$ bdm [options] <src> <dest>
# or use the "{%= name %}" alias in case of conflicts
$ {%= name %} [options] <src> <dest>

CLI examples

Get http://breakdance.io/plugins.html and convert it to markdown with breakdance, then write it to plugins.md.

$ bdm http://breakdance.io/plugins.html
# or using flags
$ bdm -s http://breakdance.io/plugins.html -d foo.md
# "pick" just the ".main-content" section from the page
$ bdm -s http://breakdance.io/plugins.html -d foo.md -p ".main-content"

CLI options

Usage: $ bdm [options] <src> <dest>

   src:  The URL of the source file to convert to markdown
  dest:  Name of the markdown destination file to create.
         By default the HTML filename is used with a .md
         extension.

Options:

  -h, --help     Show this help menu in the terminal
  -s, --src      Show this help menu in the terminal
  -c, --condense Collapse more than two newlines to only
                 two newlines. Enabled by default
  -d, --dest     The destination filepath to use.
  -o, --omit     One or more tags to omit entirely from
                 the HTML before converting to markdown.
  -p, --pick     One or more tags to pick entirely from the
                 HTML before converting to markdown.
  --comments     Include HTML code comments in the generated
                 markdown string. Disabled by default