{"id":19258507,"url":"https://github.com/breakdance/generate-breakdance","last_synced_at":"2025-06-29T13:03:03.853Z","repository":{"id":143867694,"uuid":"80959969","full_name":"breakdance/generate-breakdance","owner":"breakdance","description":"Generate a plugin for breakdance.","archived":false,"fork":false,"pushed_at":"2017-02-05T06:42:11.000Z","size":9,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-21T15:41:22.896Z","etag":null,"topics":["breakdance","generate","generator","plugin","project","scaffolder","scaffolding","template"],"latest_commit_sha":null,"homepage":"http://breakdance.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/breakdance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-02-05T01:10:21.000Z","updated_at":"2019-10-17T23:05:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"90f91d29-78c5-426e-9ec7-e6a61dc65a7a","html_url":"https://github.com/breakdance/generate-breakdance","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/breakdance/generate-breakdance","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakdance%2Fgenerate-breakdance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakdance%2Fgenerate-breakdance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakdance%2Fgenerate-breakdance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakdance%2Fgenerate-breakdance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/breakdance","download_url":"https://codeload.github.com/breakdance/generate-breakdance/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakdance%2Fgenerate-breakdance/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262598139,"owners_count":23334667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["breakdance","generate","generator","plugin","project","scaffolder","scaffolding","template"],"created_at":"2024-11-09T19:13:35.242Z","updated_at":"2025-06-29T13:03:03.795Z","avatar_url":"https://github.com/breakdance.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generate-breakdance [![NPM version](https://img.shields.io/npm/v/generate-breakdance.svg?style=flat)](https://www.npmjs.com/package/generate-breakdance) [![NPM monthly downloads](https://img.shields.io/npm/dm/generate-breakdance.svg?style=flat)](https://npmjs.org/package/generate-breakdance)  [![NPM total downloads](https://img.shields.io/npm/dt/generate-breakdance.svg?style=flat)](https://npmjs.org/package/generate-breakdance) [![Linux Build Status](https://img.shields.io/travis/generate/generate-breakdance.svg?style=flat\u0026label=Travis)](https://travis-ci.org/generate/generate-breakdance)\n\n\u003e Generate a new breakdance plugin project.\n\n## Table of Contents\n\n- [Install](#install)\n- [CLI usage](#cli-usage)\n- [Available tasks](#available-tasks)\n- [API usage](#api-usage)\n- [About](#about)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save generate-breakdance\n```\n\n## CLI usage\n\nOnce both [generate](https://github.com/generate/generate) and `generate-breakdance` are installed globally, run the following command to run this generator's default task:\n\n```sh\n$ gen breakdance\n```\n\n## Available tasks\n\nAll tasks beside the default task are run by appending the task name to `breakdance:`.\n\n### [default task](generator.js#L34)\n\nRun the generator's default task to scaffold out a new breakdance plugin project.\n\n**Example**\n\n```sh\n$ gen breakdance\n```\n\n### [plugin-only](generator.js#L48)\n\nGenerate only the `index.js` file for a breakdance plugin. Use `--stem` to change the file name.\n\n**Example**\n\n```sh\n$ gen breakdance:plugin-only\n$ gen breakdance:plugin-only --stem foo.js\n```\n\n### [compiler](generator.js#L60)\n\nScaffold out a complete project for a breakdance **compiler** plugin.\n\n**Example**\n\n```sh\n$ gen breakdance:compiler\n```\n\n### [compiler-only](generator.js#L74)\n\nGenerate only the `index.js` file for a compiler plugin. Use `--stem` to change the file name.\n\n**Example**\n\n```sh\n$ gen breakdance:compiler-only\n$ gen breakdance:compiler-only --stem foo.js\n```\n\n### [parser](generator.js#L86)\n\nScaffold out a complete project for a breakdance parser plugin.\n\n**Example**\n\n```sh\n$ gen breakdance:parser\n```\n\n### [parser-only](generator.js#L100)\n\nGenerate only the `index.js` file for a breakdance parser plugin. Use `--stem` to change the file name.\n\n**Example**\n\n```sh\n$ gen breakdance:parser-only\n$ gen breakdance:parser-only --stem foo.js\n```\n\n## API usage\n\nTo extend your own generator with the tasks and functionality of `generate-breakdance`, inside your generator add the following line of code:\n\n```js\napp.use(require('generate-breakdance'));\n```\n\n## About\n\n### Related projects\n\n* [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.\")\n* [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.\")\n* [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.\")\n* [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.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(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.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n### Running tests\n\nRunning 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:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nMIT\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 05, 2017._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreakdance%2Fgenerate-breakdance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbreakdance%2Fgenerate-breakdance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreakdance%2Fgenerate-breakdance/lists"}