如何在GitHub Markdown表格中绘制复选框或勾选标记?

803

我可以在Github的README.md列表中绘制复选框,方法是

- [ ] (for unchecked checkbox)
- [x] (for checked checkbox)

但是这在表格中不起作用。有人知道如何在GitHub Markdown表格中实现复选框或勾选标记吗?

但这在表格中不起作用,是否有人知道如何在GitHub Markdown表格中使用复选框或勾选标记?


2
请查看 GitHub 博客 https://github.blog/2014-04-28-task-lists-in-all-markdown-documents/。 - Sagynbek Kenzhebaev
2
Markdown 要求您在复选框后添加一些文本。例如,- [ ] myLabel - Piano Telope
似乎 Stackoverflow 的 Markdown 中没有复选框可用! - Avatar
13个回答

1084

尝试在[ ][x]之前添加-。这是一个连字符-后面跟着一个空格 。未选中的框还需要在方括号之间加上一个空格

下面是Github博客的示例。

### Solar System Exploration, 1950s – 1960s

- [ ] Mercury
- [x] Venus
- [x] Earth (Orbit/Moon)
- [x] Mars
- [ ] Jupiter
- [ ] Saturn
- [ ] Uranus
- [ ] Neptune
- [ ] Comet Haley

它看起来像下面这样:

Resultant Image

以下是如何在表格中完成相同的操作:

| Task           | Time required | Assigned to   | Current Status | Finished | 
|----------------|---------------|---------------|----------------|-----------|
| Calendar Cache | > 5 hours  |  | in progress | - [x] ok?
| Object Cache   | > 5 hours  |  | in progress | [x] item1<br/>[ ] item2
| Object Cache   | > 5 hours  |  | in progress | <ul><li>- [x] item1</li><li>- [ ] item2</li></ul>
| Object Cache   | > 5 hours  |  | in progress | <ul><li>[x] item1</li><li>[ ] item2</li></ul>


- [x] works
- [x] works too

这是它的外观:

enter image description here


4
最初的问题存在格式错误。它适用于列表,但不适用于表格。 - Gaurav Bishnoi
30
这看起来很不错,但是复选框有问题。如果你点击一个复选框,它什么也不做。通常点击 GitHub Markdown 复选框会选中/取消选中它。解决方法是手动编辑 HTML,这并不是很理想,但可行。 - DumpsterDoofus
1
这只是创建一个复选框的外观,该项实际上不会响应单击事件,这将取消它们的目的:从md渲染模式而不是原始文本中进行检查。 - Eduardo Pignatelli
4
@DumpsterDoofus,您是说这在问题/合并请求中不起作用吗?通常,在GitHub / GitLab的问题和合并请求中,复选框是可点击的,因为它们在这些位置上类似于购物清单,但在文档中,用户点击复选框的含义是什么?您真的想看到您的Markdown被编辑吗? - Joël
1
@Joël 嗯,是的,我希望复选框可以被点击。有很多合并请求中,购物清单都在表格中。无论如何,如果需要的话,决定因素应该是文档的范围,而不是复选框所出现的元素类型。 - undefined
显示剩余5条评论

176

现在支持表情符号!:white_check_mark: / :heavy_check_mark: 印象良好且得到广泛支持:

Function | MySQL / MariaDB | PostgreSQL | SQLite
:------------ | :-------------| :-------------| :-------------
substr | :heavy_check_mark: |  :white_check_mark: | :heavy_check_mark:

渲染为(这里是在较旧的Chromium 65.0.3x上):

输入图像描述


3
渲染输出效果看起来不错,但缺点是在“源代码”中会占用很多空间且难以阅读。而可读性是 Markdown 的重要概念之一。 - Daniel
10
我认为这可能已经过时了,因为“:white_check_mark:”现在看起来像一个带有白色勾号的绿色复选框。 - Rami A.
@davidkonrad,请参见 https://dev59.com/C1YN5IYBdhLWcg3wfoRj#59674743,特别是 https://gist.github.com/rxaviers/7360908。我正在Windows上使用Firefox 76.0.1和Chrome 81.0.4044.138。 - Rami A.
1
@ERJAN,[OT] 是的,有很多,超过100个。这些来自一个内部项目的文档,该项目提供对各种数据库管理系统的同质化访问。在本地支持不同或缺少SQL函数的情况下,功能会进行调整,以便使用流行的SQL函数返回完全相同的结果,无论平台如何,这就是灰色复选标记的含义。不能保证什么,但开源它的域名已经购买,是crudder.net。我需要的只是时间。 - davidkonrad
1
现在在VS Code中需要安装https://marketplace.visualstudio.com/items?itemName=bierner.markdown-emoji以支持表情符号。 - JyotiKumarPoddar
显示剩余4条评论

113

我使用&#9744;(☐)代表[ ],使用&#9745;(☑)代表[x]。这个方法在marked.js上能正常工作,该插件声称与Github的markdown兼容。我的解决方案基于此问题的答案。另请参见此信息性答案

更新:当你使用这种方法时,不需要<ul>,例如:

| Unchecked | Checked |
| --------- | ------- |
| &#9744;   | &#9745; |

这个也可以,除了被接受的答案之外。事实上,我已经在GitHub上成功地使用过它。感谢你为大家指出这一点。我应该早点这样做的。 - Gaurav Bishnoi
14
好的,我将尽力进行翻译。请提供需要翻译的内容。 - Mawardy
请注意,某些表情符号在 GitHub 问题显示和编辑器中呈现的方式不同:☑ 在编辑器中看起来是黑白色的,但在渲染后变成了带有红色标记的方框。勾选按钮✅在渲染时变成了“白色”勾选标记,尽管在编辑器中看起来是绿色的。勾选标记✔️在编辑器中看起来是黑色的,但在问题中被渲染为绿色勾选标记。 - Ingo Steinke

103

2
谢谢。这对我来说是最容易记住的。 :) - DrGeneral

72

69

你可以使用表情符号

Done? | Name
:---:| ---
⬜️| Nope
✅| Yep

3
我该写什么来使用第一个表情符号?我知道第二个是“:heavy_check_mark:”。 - Eldar
5
未选框使用:white_large_square,已选框使用:white_check_mark - Dexter
2
Github支持的表情符号列表:https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md - InsertCheesyLine

33

很遗憾,被接受的答案对我并没有用(我正在使用GitHub风格的Markdown)。

既然我们正在添加HTML元素,为什么不直接添加一个<input>呢。

| demo                                              | demo |
| ------------------------------------------------- | ---- |
| <input type="checkbox" disabled checked /> works  |      |
| <input type="checkbox" disabled /> works here too |      |

这应该在任何环境下都可以工作,因为它是纯HTML(请参见下面的FYI)。

Rendered result

顺便提一下,此示例已在VS Code markdown预览模式(GitHub风格)中进行了测试,截图也是在VS Code预览模式下拍摄的。 它不能在GitHub上工作。

如果此方法无法在目标环境中工作,则上述提到的表情符号是一个很好的替代方案。


2
这不会在Github中显示。 - Liam Pillay

15

2021年9月

如果你在使用标准的Markdown代码时遇到问题,你可以使用表情符号。

Github原生表情符号

如果你在使用GitHub默认的表情符号,你可以使用以下表情符号。需要注意的是,没有未选中的方框,所以您必须使用不同的表情符号来实现这个效果。

:white_large_square

:white_check_mark

来源

:white_large_square: https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#geometric
:white_check_mark: https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#other-symbol

完整列表 https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md


14

编辑文档或wiki页面,并使用 - [ ]- [x] 语法更新您的任务清单。此外,您可以参考此链接


你可以使用竖线 | 和连字符 - 来创建表格,然后在表格内部使用 - [ ] 和 - [x] 语法来绘制复选框。 - Joseph Charles
@JosephCharles 请问您能否提供示例代码,展示如何在表格中实现它的工作? - Pocketsand
8
这不会起作用,也没有回答问题。 - coisnepe

3

以下是我为您和其他人提供的有关Markdown复选框表格的帮助。享受吧!

| Projects | Operating Systems | Programming Languages   | CAM/CAD Programs | Microcontrollers and Processors | 
|---------------------------------- |---------------|---------------|----------------|-----------|
| <ul><li>[ ] Blog </li></ul>       | <ul><li>[ ] CentOS</li></ul>        | <ul><li>[ ] Python </li></ul> | <ul><li>[ ] AutoCAD Electrical </li></ul> | <ul><li>[ ] Arduino </li></ul> |
| <ul><li>[ ] PyGame</li></ul>   | <ul><li>[ ] Fedora </li></ul>       | <ul><li>[ ] C</li></ul> | <ul><li>[ ] 3DsMax </li></ul> |<ul><li>[ ] Raspberry Pi </li></ul> |
| <ul><li>[ ] Server Info Display</li></ul>| <ul><li>[ ] Ubuntu</li></ul> | <ul><li>[ ] C++ </li></ul> | <ul><li>[ ] Adobe AfterEffects </li></ul> |<ul><li>[ ]  </li></ul> |
| <ul><li>[ ] Twitter Subs Bot </li></ul> | <ul><li>[ ] ROS </li></ul>    | <ul><li>[ ] C# </li></ul> | <ul><li>[ ] Adobe Illustrator </li></ul> |<ul><li>[ ]  </li></ul> |

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接