markdown-it-checkbox

WebJar for markdown-it-checkbox

License	MIT
GroupId	org.webjars.bower
ArtifactId	markdown-it-checkbox
Last Version	1.1.0
Release Date	Feb 8, 2016
Type	jar
Description	markdown-it-checkbox WebJar for markdown-it-checkbox
Project URL	http://webjars.org
Source Code Management	https://github.com/mcecot/markdown-it-checkbox

Download markdown-it-checkbox

Filename	Size
markdown-it-checkbox-1.1.0.pom
markdown-it-checkbox-1.1.0.jar	9 KB
markdown-it-checkbox-1.1.0-sources.jar	22 bytes
markdown-it-checkbox-1.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bower/markdown-it-checkbox/ -->
<dependency>
    <groupId>org.webjars.bower</groupId>
    <artifactId>markdown-it-checkbox</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bower/markdown-it-checkbox/
implementation 'org.webjars.bower:markdown-it-checkbox:1.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bower/markdown-it-checkbox/
implementation ("org.webjars.bower:markdown-it-checkbox:1.1.0")

Apache Buildr

'org.webjars.bower:markdown-it-checkbox:jar:1.1.0'

Apache Ivy

<dependency org="org.webjars.bower" name="markdown-it-checkbox" rev="1.1.0">
  <artifact name="markdown-it-checkbox" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bower', module='markdown-it-checkbox', version='1.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.bower" % "markdown-it-checkbox" % "1.1.0"

Leiningen

[org.webjars.bower/markdown-it-checkbox "1.1.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

markdown-it-checkbox

Plugin to create checkboxes for markdown-it markdown parser.

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

Usage

Install

node.js, browser:

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

Use

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

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.

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 © 2015 Markus Cecot

Versions

Version
1.1.0 Feb 8, 2016