Installations

npm install @hackmd/markdown-it-task-lists

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.18.0

NPM Version

9.8.1 Score

70.8

Supply Chain

91.4

Quality

80.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

14

Closed

3

Merged

7

Issues

Open

2

Total

21

Closed

19

Releases

Unable to fetch releases

Contributors

3

Unable to fetch Contributors

View all 3 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

revin

Download Statistics

Total Downloads

22,215

Last Day

22

Last Week

178

Last Month

1,043

Last Year

9,048

GitHub Statistics

97 Stars

41 Commits

33 Forks

3 Watching

30 Branches

3 Contributors

Bundle Size

1.97 kB

Minified

832.00 B

Minified + Gzipped

Bundlephobia

Maintainers

3

Package Meta Information

Latest Version

2.1.4

Package Id

@hackmd/markdown-it-task-lists@2.1.4

Unpacked Size

15.36 kB

Size

5.06 kB

File Count

11

NPM Version

9.8.1

Node Version

18.18.0

Publised On

27 Mar 2024

Total Downloads

Cumulative downloads

Total Downloads

22,215

Last day

-59.3%

22

Compared to previous day

Last week

-29.9%

178

Compared to previous week

Last month

37.1%

1,043

Compared to previous month

Last year

116.7%

9,048

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

5

browserify cheerio markdown-it mocha uglify

Versions

markdown-it-task-lists

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

What it does

Builds task/todo lists 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

1npm install markdown-it-task-lists

Usage

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

1var md = require('markdown-it');
2var taskLists = require('markdown-it-task-lists');
3
4var parser = md().use(taskLists);
5
6var 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:

1var 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:

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

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

1var 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

1npm install
2npm test

License

ISC

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More