Description
The new-project-checklist page uses GitHub-style task list syntax (* [ ]) in the source Markdown:
* [ ] Technical problem addressed by the project
* [ ] Intended users and value proposition
However, MyST/Sphinx does not natively support the * [ ] / - [ ] task list syntax. The [ ] markers are rendered as literal text instead of checkboxes. Additionally, Sphinx wraps each list item's content in <p> tags (<ul class="simple"><li><p>[ ] ...</p></li></ul>), which creates excessive vertical spacing between items.
This affects both the English and Chinese versions of the page.
Affected pages
Expected rendering
- Checkbox items displayed with actual checkbox styling (☐ or
<input type="checkbox">)
- Compact list spacing consistent with other list pages
Actual rendering
[ ] displayed as literal text
- Each list item has extra vertical spacing due to
<p> wrapping
Suggested fix
- Enable the
tasklist extension in myst_parser configuration — MyST supports myst_enable_extensions = ["tasklist"] which renders - [ ] as checkboxes
- Alternatively, use
sphinx.ext.todo or a custom directive for checklist items
- Address the
<p> wrapping by overriding the simple list CSS to reduce spacing
Description
The new-project-checklist page uses GitHub-style task list syntax (
* [ ]) in the source Markdown:However, MyST/Sphinx does not natively support the
* [ ]/- [ ]task list syntax. The[ ]markers are rendered as literal text instead of checkboxes. Additionally, Sphinx wraps each list item's content in<p>tags (<ul class="simple"><li><p>[ ] ...</p></li></ul>), which creates excessive vertical spacing between items.This affects both the English and Chinese versions of the page.
Affected pages
Expected rendering
<input type="checkbox">)Actual rendering
[ ]displayed as literal text<p>wrappingSuggested fix
tasklistextension inmyst_parserconfiguration — MyST supportsmyst_enable_extensions = ["tasklist"]which renders- [ ]as checkboxessphinx.ext.todoor a custom directive for checklist items<p>wrapping by overriding thesimplelist CSS to reduce spacing