generate-breakdance

Generate a new breakdance plugin project.

Table of Contents

• Install
• CLI usage
• Available tasks
• API usage
• About

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save generate-breakdance

CLI usage

Once both generate and generate-breakdance are installed globally, run the following command to run this generator's default task:

$ gen breakdance

Available tasks

All tasks beside the default task are run by appending the task name to breakdance:.

default task

Run the generator's default task to scaffold out a new breakdance plugin project.

Example

$ gen breakdance

plugin-only

Generate only the index.js file for a breakdance plugin. Use --stem to change the file name.

Example

$ gen breakdance:plugin-only
$ gen breakdance:plugin-only --stem foo.js

compiler

Scaffold out a complete project for a breakdance compiler plugin.

Example

$ gen breakdance:compiler

compiler-only

Generate only the index.js file for a compiler plugin. Use --stem to change the file name.

Example

$ gen breakdance:compiler-only
$ gen breakdance:compiler-only --stem foo.js

parser

Scaffold out a complete project for a breakdance parser plugin.

Example

$ gen breakdance:parser

parser-only

Generate only the index.js file for a breakdance parser plugin. Use --stem to change the file name.

Example

$ gen breakdance:parser-only
$ gen breakdance:parser-only --stem foo.js

API usage

To extend your own generator with the tasks and functionality of generate-breakdance, inside your generator add the following line of code:

app.use(require('generate-breakdance'));

About

Related projects

• breakdance-checklist: Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown. | homepage
• breakdance-reflinks: Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of… more | 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

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

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