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

    breakdance-checklist

    0.1.4 • Public • Published

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

    Plugin that adds checklist rendering support to breakdance, similar to task lists in github-flavored-markdown.

    Install

    Install with npm:

    $ npm install --save breakdance-checklist

    Usage

    var Breakdance = require('breakdance');
    var checklist = require('breakdance-checklist');
    var bd = new Breakdance();
      .use(checklist());
     
    console.log(bd.render('<li><input type="checkbox">Lorem ipsum</li>'));
    //=> '* [ ] Lorem ipsum'

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

    Examples

    lists

    Create checkboxes from list items.

    Unchecked

    <li><input type="checkbox">Lorem ipsum dolor sit amet</li>

    Is converted to:

    * [ ] Lorem ipsum dolor sit amet
    

    Checked

    <li><input type="checkbox checked">Lorem ipsum dolor sit amet</li>

    Is converted to:

    * [x] Lorem ipsum dolor sit amet
    

    Full example

    <ul>
      <li> <input type="checkbox"> foo </li>
      <li> <input type="checkbox" checked> bar </li>
      <li> <input type="checkbox"> baz </li>
    </ul>

    Converts to

    * [ ] foo
    * [x] bar
    * [ ] baz
    

    input

    Converts an HTML input with the type="checkbox" attribute.

    Unchecked

    <input type="checkbox" />Lorem ipsum dolor sit amet

    Converts to:

    * [ ] Lorem ipsum dolor sit amet
    

    Checked

    The following:

    <input type="checkbox checked" />Lorem ipsum dolor sit amet

    Converts to:

    * [x] Lorem ipsum dolor sit amet
    

    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-checklist

    DownloadsWeekly Downloads

    7

    Version

    0.1.4

    License

    MIT

    Last publish

    Collaborators

    • avatar