Task list

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

Settings

import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";

export default defineUserConfig({
  theme: hopeTheme({
    markdown: {
      tasklist: true,
    },
  }),
});

Syntax

• Use - [ ] some text to render an 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 markdown.tasklist: true in theme options, you can also pass objects as options:

import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";

export default defineUserConfig({
  theme: hopeTheme({
    markdown: {
      tasklist: {
        /**
         * Whether disable checkbox
         *
         * @default true
         */
        disabled: false,

        /**
         * Whether use `<label>` to wrap text
         *
         * @default true
         */
        label: false,
      },
    },
  }),
});