Gathering detailed insights and metrics for @hedgedoc/markdown-it-task-lists
Installations
npm install @hedgedoc/markdown-it-task-listsDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Score
65.6
Supply Chain
89.4
Quality
77.7
Maintenance
100
Vulnerability
80.6
License
Releases
2
Contributors
11
Unable to fetch Contributors
Languages
1
TypeScript
TypeScript (100%)
Developer
hedgedoc
Download Statistics
Total Downloads
173,636
Last Day
20
Last Week
115
Last Month
775
Last Year
27,256
GitHub Statistics
7 Stars
237 Commits
4 Forks
6 Watching
1 Branches
11 Contributors
Maintainers
2
Package Meta Information
Latest Version
2.0.1
Package Id
@hedgedoc/markdown-it-task-lists@2.0.1
Unpacked Size
67.78 kB
Size
16.81 kB
File Count
16
Total Downloads
Cumulative downloads
Total Downloads
173,636
Last day
-68.3%
20
Compared to previous day
Last week
-39.2%
115
Compared to previous week
Last month
-19.3%
775
Compared to previous month
Last year
-45.6%
27,256
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Versions
DEPRECATED
Use https://github.com/hedgedoc/markdown-it-plugins instead
markdown-it-better-task-lists
This is a typescript port of markdown-it-task-lists markdown-it plugin for generating 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.
Usage
Use it the same as a normal markdown-it plugin:
1import MarkdownIt from 'markdown-it' 2import taskLists from '@hedgedoc/markdown-it-task-lists' 3 4const parser = new MarkdownIt().use(taskLists) 5 6const result = parser.render(` 7- [ ] Open task 8- [x] Done task 9- Not a task 10`) // markdown string containing task list items
The rendered checkboxes are disabled; to change this, set enabled property of the
plugin options to true:
1const parser = new MarkdownIt().use(taskLists, { enabled: true })
If you need to know which line in the markdown document the generated checkbox comes
set the lineNumber property of the plugin options to true for the
<input> tag to be created with a data-line attribute containing the line number:
1const parser = new MarkdownIt().use(taskLists, { lineNumber: true })
If you'd like to wrap the rendered list items in a <label> element for UX
purposes, set the label property of the plugin options to true:
1const parser = new MarkdownIt().use(taskLists, { label: true })
To add the label after the checkbox set the labelAfter property of the plugin
options to true:
1const parser = new MarkdownIt().use(taskLists, { label: true, labelAfter: true })
Note: This option does require the label option to be truthy.
The options can be combined, of course.
Tests
1yarn install 2yarn test
License
ISC
No vulnerabilities found.
No security vulnerabilities found.