Skip to content

docs(site): render Markdown task lists #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SigureMo merged 2 commits into from
Sep 3, 2026
+20 −2
Merged

docs(site): render Markdown task lists #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5582ab2
docs(site): render Markdown task lists
ShigureNyako Sep 3, 2026
8effd20
docs(site): use task list plugin
ShigureNyako Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/.vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import taskLists from 'markdown-it-task-lists'
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
Expand Down Expand Up @@ -209,9 +210,12 @@ export default defineConfig({
// Ignore dead links for source code references and placeholder pages
ignoreDeadLinks: true,

// Enable LaTeX math rendering
// Enable LaTeX math rendering and GitHub-style task lists
markdown: {
math: true
math: true,
config(md) {
md.use(taskLists)
}
},
Comment thread
ShigureNyako marked this conversation as resolved.

// 多语言配置
Expand Down
13 changes: 13 additions & 0 deletions docs/.vitepress/theme/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,19 @@
background: rgba(0, 0, 0, 0.9) !important;
}

/**
* Component: Task List
* -------------------------------------------------------------------------- */

.vp-doc li.task-list-item {
list-style: none;
}

.vp-doc .task-list-item-checkbox {
margin: 0 0.5em 0 -1.4em;
vertical-align: middle;
}
Comment thread
ShigureNyako marked this conversation as resolved.

/**
* ASCII Art Background — Dark Home Page
* -------------------------------------------------------------------------- */
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"devDependencies": {
"@types/node": "^20.19.37",
"markdown-it-task-lists": "^2.1.1",
"medium-zoom": "^1.1.0",
"mermaid": "^10.0.0",
"swagger-ui-dist": "^5.32.1",
Expand Down
Loading