# markdown-it-checkbox

> Plugin to create checkboxes for markdown-it markdown parser

Latest version **1.1.0** (published 2015-03-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-checkbox
pnpm add markdown-it-checkbox
yarn add markdown-it-checkbox
bun add markdown-it-checkbox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-03-23 |
| First published | 2015-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 37 |
| Maintainers | mcecot |
| Keywords | markdown-it-plugin, markdown-it, markdown |

## Links

- npm: https://www.npmjs.com/package/markdown-it-checkbox
- Repository: https://github.com/mcecot/markdown-it-checkbox
- Issues: https://github.com/mcecot/markdown-it-checkbox/issues
- npm.io page: https://npm.io/package/markdown-it-checkbox

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) ^1.8.2

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2015-03-23
- 1.0.1 — 2015-03-18
- 1.0.0 — 2015-03-17

## README

# markdown-it-checkbox [![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency Status][depstat-image]][depstat-url] [![devDependency Status][devdepstat-image]][devdepstat-url]

> Plugin to create checkboxes for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.

This plugin allows to create checkboxes for tasklists as discussed [here](http://talk.commonmark.org/t/task-lists-in-standard-markdown/41).



## Usage

## Install

node.js, browser:

```bash
npm install markdown-it-checkbox --save
bower install markdown-it-checkbox --save
```

## Use

```js
var md = require('markdown-it')()
            .use(require('markdown-it-checkbox'));

md.render('[ ] unchecked') // =>
// <p>
//  <input type="checkbox" id="checkbox0">
//  <label for="checkbox0">unchecked</label>
// </p>

md.render('[x] checked') // =>
// <p>
//  <input type="checkbox" id="checkbox0" checked="true">
//  <label for="checkbox0">checked</label>
// </p>
```

_Differences in browser._ If you load script directly into the page, without
package system, module will add itself globally as `window.markdownitCheckbox`.

## Options

```js
var md = require('markdown-it')()
            .use(require('markdown-it-checkbox'),{
              divWrap: true,
              divClass: 'cb',
              idPrefix: 'cbx_'
            });

md.render('[ ] unchecked') // =>
// <p>
//  <div classname="cb">
//    <input type="checkbox" id="cbx_0">
//    <label for="cbx_0">unchecked</label>
//  </div>
// </p>
```

## divWrap

* **Type:** `Boolean`
* **Default:** `false`

wrap div arround checkbox. this makes it possible to use it for example with [Awesome Bootstrap Checkbox](https://github.com/flatlogic/awesome-bootstrap-checkbox/).

## divClass

* **Type:** `String`
* **Default:** `checkbox`

classname of div wrapper. will only be used if `divWrap` is enanbled.

## idPrefix

* **Type:** `String`
* **Default:** `checkbox`

the id of the checkboxs input contains the prefix and an incremental number starting with `0`. i.e. `checkbox1` for the 2nd checkbox.


## License

[MIT License](https://github.com/mcecot/markdown-it-checkbox/blob/master/LICENSE) © 2015 Markus Cecot

[npm-url]: https://npmjs.org/package/markdown-it-checkbox
[npm-image]: https://img.shields.io/npm/v/markdown-it-checkbox.svg

[travis-url]: http://travis-ci.org/mcecot/markdown-it-checkbox
[travis-image]: https://secure.travis-ci.org/mcecot/markdown-it-checkbox.svg?branch=master

[coveralls-url]: https://coveralls.io/r/mcecot/markdown-it-checkbox
[coveralls-image]: https://img.shields.io/coveralls/mcecot/markdown-it-checkbox.svg

[depstat-url]: https://david-dm.org/mcecot/markdown-it-checkbox
[depstat-image]: https://david-dm.org/mcecot/markdown-it-checkbox.svg

[devdepstat-url]: https://david-dm.org/mcecot/markdown-it-checkbox#info=devDependencies
[devdepstat-image]: https://david-dm.org/mcecot/markdown-it-checkbox/dev-status.svg

---
_Source: https://npm.io/package/markdown-it-checkbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._