markdown-it-todo-lists

A markdown-it plugin to create todo lists.

• item 1
• item 2
• item 3

1- [ ] item 1
2- [x] item 2
3- [X] item 3

Usage

1npm i markdown-it-todo-lists

1import MarkdownIt from 'markdown-it'
2import MarkdownItTodoLists from 'markdown-it-todo-lists'
3
4const md = MarkdownIt()
5
6md.use(MarkdownItTodoLists, /* Options */)
7
8const html = md.render(/* ... */)

For the options available, please refer to the jsdoc.

Functionality

1- [ ] item 1
2- [x] item 2

Use enabled = true in options:

1md.use(MarkdownItTodoLists, {
2  enabled: true
3})

to HTML:

1<ul class="todo-list-container">
2  <li class="todo-list-item">
3    <input class="todo-list-item-checkbox" type="checkbox" />item 1
4  </li>
5  <li class="todo-list-item">
6    <input class="todo-list-item-checkbox" type="checkbox" checked />item 2
7  </li>
8</ul>

Use useLabel = true in options:

1md.use(MarkdownItTodoLists, {
2  useLabel: true
3})

to HTML:

1<ul class="todo-list-container">
2  <li class="todo-list-item">
3    <label>
4      <input class="todo-list-item-checkbox" type="checkbox" disabled />item 1
5    </label>
6  </li>
7  <li class="todo-list-item">
8    <label>
9      <input class="todo-list-item-checkbox" type="checkbox" checked disabled />item 2
10    </label>
11  </li>
12</ul>

License

MIT License © 2024-PRESENT Leet