Task list

Let the Markdown file in your VuePress site support task list.

Config

module.exports = {
  plugins: [
    [
      "md-enhance",
      {
        // Enable Task List
        tasklist: true,
      },
    ],
  ],
};

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)

Demo

• Plan A
• Plan B

- [ ] Plan A
- [x] Plan B

Advanced

Besides setting tasklist: true in the plugin options, you can also pass objects to it as options. The available options are as follows:

interface TaskListOptions {
  /**
   * Whether disable checkbox
   *
   * @default true
   */
  disabled?: boolean;

  /**
   * Whether use `<label>` to wrap text
   *
   * @default true
   */
  label?: boolean;
}