Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including markdown-it-checkbox with all npm packages installed. Try it out:

var markdownItCheckbox = require("markdown-it-checkbox")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

markdown-it-checkbox v1.1.0

Plugin to create checkboxes for markdown-it markdown parser

markdown-it-checkbox NPM version

Build Status Coverage Status Dependency Status devDependency Status

Plugin to create checkboxes for markdown-it markdown parser.

This plugin allows to create checkboxes for tasklists as discussed here.



node.js, browser:

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


var md = require('markdown-it')()

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.


var md = require('markdown-it')()
              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>


  • Type: Boolean
  • Default: false

wrap div arround checkbox. this makes it possible to use it for example with Awesome Bootstrap Checkbox.


  • Type: String
  • Default: checkbox

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


  • 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.


MIT License © 2015 Markus Cecot


RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free