docs(site): render Markdown task lists - #299
Merged
SigureMo merged 2 commits intoSep 3, 2026
Merged
Conversation
# 📝 Documentation ## Render documentation checklists as checkbox lists - Convert valid task-list markers into disabled checkbox inputs during the VitePress build - Style task items without duplicate list bullets - Preserve support for unchecked and checked task markers without adding a dependency
SigureMo
requested changes
Sep 3, 2026
# 📝 Documentation ## Adopt the VitePress-recommended Markdown-it plugin - Replace the local task-list renderer with markdown-it-task-lists - Keep the existing scoped task-list styling - Use the established dependency recommended in VitePress issue discussions Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
SigureMo
reviewed
Sep 3, 2026
SigureMo
reviewed
Sep 3, 2026
SigureMo
left a comment
Collaborator
There was a problem hiding this comment.
话说你能在 PR 描述里加一下 before / after 的局部截图吗?
Contributor
Author
|
已补充完成:PR 描述的 Screenshots / Logs 现在并排展示 before / after 局部截图。两张图分别来自同一中文贡献指南页面在 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Why
The English and Chinese contribution checklists already store each task on its own valid
- [ ] ...source line. However, VitePress's Markdown pipeline does not enable GitHub-style task lists by default, so the built pages emitted literal[ ]text instead of checkbox controls.How
Configure VitePress to use the established
markdown-it-task-listsplugin recommended by the VitePress maintainers in vuejs/vitepress#1923. The plugin recognizes[ ],[x], and[X]list-item markers, emits disabled checkbox inputs, and tags the generated list markup for scoped theme styling.Testing
pre-commit run --all-filespassespytest tests/) — GitHub CI passed on Python 3.10, 3.11, and 3.12Additional validation:
npm run docs:build— passed; generated all four OpenAPI specs and completed the VitePress build.Type of Change
Screenshots / Logs
Local VitePress builds of the same Chinese contribution-guide section at
origin/mainand this PR's head: