# markdown-it-task-lists

> A markdown-it plugin to create GitHub-style task lists

Latest version **2.1.1** (published 2018-03-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install markdown-it-task-lists
pnpm add markdown-it-task-lists
yarn add markdown-it-task-lists
bun add markdown-it-task-lists
```

## 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 | 2.1.1 |
| Published | 2018-03-06 |
| First published | 2016-03-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 105 |
| Author | Revin Guillen |
| Maintainers | revin |
| Keywords | markdown, markdown-it, markdown-it-plugin, task, list, todo, checkbox |

## Links

- npm: https://www.npmjs.com/package/markdown-it-task-lists
- Repository: https://github.com/revin/markdown-it-task-lists
- Homepage: https://github.com/revin/markdown-it-task-lists#readme
- Issues: https://github.com/revin/markdown-it-task-lists/issues
- npm.io page: https://npm.io/package/markdown-it-task-lists

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

- 2.1.1 (latest) — 2018-03-06
- 2.1.0 — 2017-10-23
- 2.0.1 — 2017-05-02
- 2.0.0 — 2017-03-31
- 1.4.1 — 2016-07-25
- 1.4.0 — 2016-07-19
- 1.3.0 — 2016-07-13
- 1.2.2 — 2016-06-21
- 1.2.1 — 2016-06-21
- 1.2.0 — 2016-03-31
- 1.1.1 — 2016-03-27
- 1.1.0 — 2016-03-27
- 1.0.1 — 2016-03-25
- 1.0.0 — 2016-03-25

## README

# markdown-it-task-lists

A [markdown-it](https://www.npmjs.com/package/markdown-it) plugin to create GitHub-style [task lists](https://github.com/blog/1825-task-lists-in-all-markdown-documents)

[![Greenkeeper badge](https://badges.greenkeeper.io/revin/markdown-it-task-lists.svg)](https://greenkeeper.io/)
[![Build Status](https://travis-ci.org/revin/markdown-it-task-lists.svg?branch=master)](https://travis-ci.org/revin/markdown-it-task-lists)
[![Code Climate](https://codeclimate.com/github/revin/markdown-it-task-lists/badges/gpa.svg)](https://codeclimate.com/github/revin/markdown-it-task-lists)

## What it does

- Builds [task/todo lists](https://github.com/blog/1825-task-lists-in-all-markdown-documents) out of markdown lists with items starting with `[ ]` or `[x]`.
- Nothing else

### Why is this useful?

When you have markdown documentation with checklists, rendering HTML checkboxes
out of the list items looks nicer than the raw square brackets.

## Installation

```sh
npm install markdown-it-task-lists
```

## Usage

Use it the same as a normal markdown-it plugin:

```js
var md = require('markdown-it');
var taskLists = require('markdown-it-task-lists');

var parser = md().use(taskLists);

var result = parser.render(...); // markdown string containing task list items
```

The rendered checkboxes are disabled; to change this, pass a truthy value into
the `enabled` property of the plugin options:

```js
var parser = md().use(taskLists, {enabled: true});
```

If you'd like to wrap the rendered list items in a `<label>` element for UX
purposes, pass a truthy value to the `label` property of the plugin options:

```js
var parser = md().use(taskLists, {label: true});
```

To add the label after the checkbox pass a truthy value to `labelAfter` property:

```js
var parser = md().use(taskLists, {label: true, labelAfter: true});
```

**Note:** This option does require the `label` option to be truthy.

The options can be combined, of course.

### Browser Usage

If you use one of the versions of this module available in `dist/` directly in
a browser by including it with a `<script>` element, it will be available
globally in `window.markdownitTaskLists`.

## Tests

```sh
npm install
npm test
```

## License

ISC

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