如何在 Github markdown 中使用复选框?

How to use checkbox in Github markdown?

我想在我的 PR 模板中包含一个复选框,我认为可以通过 html 实现,因为 Github markdown 支持它。它在 VScode 上运行良好,但当我按下它时,它似乎在 Github 上坏了,因为它没有呈现复选框。我可以认为有些人会建议使用这个:

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

或您可以想到的任何其他表情符号解决方案。问题是它们中的 none 确实对我有帮助,因为我希望人们简单地与复选框交互,而不是让他们进入降价并在那里插入一些文本以便呈现为复选框。知道解决办法是什么吗?

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

如果您有一个包含复选框的 HTML 表单,在用户“选中”该框后,需要将表单提交到服务器,然后需要在服务器上更新状态。 GitHub 没有执行此操作的机制。

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

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

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

* [x] checked
* [ ] not checked