Task list

Less than 1 minute

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

Config

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
- [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;
}
Loading...