Task list
Less than 1 minute
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. (CapitalX
is also supported)
Demo
- [ ] 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,
},
},
}),
});
Changelog
2/18/25, 7:08 AM
View All Changelog
b1230
-on22787
-onb41c0
-on54c46
-on55ea3
-on757fd
-on83bff
-on2a306
-on8174c
-on2fa50
-on3c8d6
-on9856d
-on23515
-on48bca
-on9cdd7
-on63d09
-onfd395
-on1eb77
-on60053
-onf6ff0
-on3c199
-on