https://github.com/breakdance/generate-breakdance
Generate a plugin for breakdance.
https://github.com/breakdance/generate-breakdance
breakdance generate generator plugin project scaffolder scaffolding template
Last synced: 12 months ago
JSON representation
Generate a plugin for breakdance.
- Host: GitHub
- URL: https://github.com/breakdance/generate-breakdance
- Owner: breakdance
- License: mit
- Created: 2017-02-05T01:10:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-05T06:42:11.000Z (over 9 years ago)
- Last Synced: 2025-04-21T15:41:22.896Z (about 1 year ago)
- Topics: breakdance, generate, generator, plugin, project, scaffolder, scaffolding, template
- Language: JavaScript
- Homepage: http://breakdance.io
- Size: 8.79 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-breakdance [](https://www.npmjs.com/package/generate-breakdance) [](https://npmjs.org/package/generate-breakdance) [](https://npmjs.org/package/generate-breakdance) [](https://travis-ci.org/generate/generate-breakdance)
> Generate a new breakdance plugin project.
## Table of Contents
- [Install](#install)
- [CLI usage](#cli-usage)
- [Available tasks](#available-tasks)
- [API usage](#api-usage)
- [About](#about)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save generate-breakdance
```
## CLI usage
Once both [generate](https://github.com/generate/generate) and `generate-breakdance` are installed globally, run the following command to run this generator's default task:
```sh
$ gen breakdance
```
## Available tasks
All tasks beside the default task are run by appending the task name to `breakdance:`.
### [default task](generator.js#L34)
Run the generator's default task to scaffold out a new breakdance plugin project.
**Example**
```sh
$ gen breakdance
```
### [plugin-only](generator.js#L48)
Generate only the `index.js` file for a breakdance plugin. Use `--stem` to change the file name.
**Example**
```sh
$ gen breakdance:plugin-only
$ gen breakdance:plugin-only --stem foo.js
```
### [compiler](generator.js#L60)
Scaffold out a complete project for a breakdance **compiler** plugin.
**Example**
```sh
$ gen breakdance:compiler
```
### [compiler-only](generator.js#L74)
Generate only the `index.js` file for a compiler plugin. Use `--stem` to change the file name.
**Example**
```sh
$ gen breakdance:compiler-only
$ gen breakdance:compiler-only --stem foo.js
```
### [parser](generator.js#L86)
Scaffold out a complete project for a breakdance parser plugin.
**Example**
```sh
$ gen breakdance:parser
```
### [parser-only](generator.js#L100)
Generate only the `index.js` file for a breakdance parser plugin. Use `--stem` to change the file name.
**Example**
```sh
$ 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:
```js
app.use(require('generate-breakdance'));
```
## About
### Related projects
* [breakdance-checklist](https://www.npmjs.com/package/breakdance-checklist): Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown. | [homepage](https://github.com/jonschlinkert/breakdance-checklist "Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown.")
* [breakdance-reflinks](https://www.npmjs.com/package/breakdance-reflinks): Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of… [more](https://github.com/jonschlinkert/breakdance-reflinks) | [homepage](https://github.com/jonschlinkert/breakdance-reflinks "Breakdance plugin that aggregates the urls from hrefs and src attributes at the bottom of the file as reference links.")
* [breakdance-util](https://www.npmjs.com/package/breakdance-util): Utility functions for breakdance plugins. | [homepage](https://github.com/jonschlinkert/breakdance-util "Utility functions for breakdance plugins.")
* [breakdance](https://www.npmjs.com/package/breakdance): Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy… [more](http://breakdance.io) | [homepage](http://breakdance.io "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.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
MIT
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 05, 2017._