如何在 Github Markdown 中使用复选框？

Question

我想在我的 PR 模板中包含一个复选框，我认为可以通过 html 实现，因为 Github markdown 支持它。它在 VScode 上确实工作得很好，但当我推送它时，它在 Github 上似乎坏了，因为它没有渲染复选框。我认为有些人会建议使用以下任一方法：

- [ ] Uranus
- [ ] Neptune
- [ ] Comet Haley

或您能想到的使用表情符号的任何其他解决方案。问题是它们都对我没有真正的帮助，因为我希望人们简单地与复选框交互，而不是让他们进入 markdown 并在那里插入一些文本以便呈现为复选框。知道有什么办法吗？

Answer 1

您只能在 GitHub 上使用基于 Markdown 的复选框。

如果您有一个包含复选框的 HTML 表单，则在用户“选中”该框后，需要将表单提交到服务器，然后需要在服务器上更新状态。GitHub 没有一个机制可以做到这一点。

此外，GitHub 会通过非常严格的清理程序传递所有用户提供的内容，从而删除许多类型的内容。我希望他们会从用户提供的内容中删除所有表单元素，因为表单将是恶意用户执行各种类型攻击的简单方法。

事实上，问题模板中包含的任何内容都将作为原始源在文本区域内向用户显示。用户将看到<input type="checkbox">而不是呈现的复选框。然后用户需要编辑它以包含属性checked：<input type="checkbox" checked>。

因此，唯一的解决方案是使用基于 Markdown 的复选框。用户需要通过在括号内添加 来编辑 Markdownx以反映某个项目已被“选中”。不用说，这比添加checked到原始 HTML 容易得多。并且它不需要提交表单或服务器来接收提交并保存新状态。

* [x] checked
* [ ] not checked