Skip to main content

@mdit/plugin-tasklist

Plugins to support tasklist.

Usage

import { tasklist } from "@mdit/plugin-tasklist";
import MarkdownIt from "markdown-it";

const mdIt = new MarkdownIt().use(tasklist, {
  // your options, optional
});

mdIt.render(`\
- [x] task 1
- [ ] task 2
`);

Syntax

  • Use - [ ] some text to render a unchecked task item.
  • Use - [x] some text to render a checked task item. (Capital X is also supported)

Options

disabledboolean
Defaulttrue

Whether to disable checkbox.

labelboolean
Defaulttrue

Whether to use <label> to wrap text.

containerClassstring
Default'task-list-container'

Class for tasklist container.

itemClassstring
Default'task-list-item'

Class for tasklist item.

labelClassstring
Default'task-list-item-label'

Class for tasklist item label.

checkboxClassstring
Default'task-list-item-checkbox'

Class for tasklist item checkbox.

Demo

Demo
- [ ] Plan A
- [x] Plan B