Clever Geek Handbook

Using markup icons in tables on Github?

I want checkboxes to appear in table cells in the github README.md file. The problem is that instead of :white_check_mark:

taking the form of a white checkmark, it instead leaves this raw literal inside the table.

Here is a complete markdown table

| Property | Type | Null | Description |
| -------- | ---- | ---- | ----------- |
| subject | string |   | Message subject |
| body_excerpt | string |   | Short excerpt of the message body |
| to | list | :white_check_mark: | Names and emails of the message recipients |
| cc | list | :white_check_mark: | Names and emails of the message recipients who were CC'd |

Any ideas why this icon can't appear?

thank

EDIT: White checkmarks are actually displayed above the example. For better reference check out the README.md in this repo

+3


source to share


1 answer


TL; DR

Your table is formatted correctly. The problem is elsewhere.

More detailed answer



Hmmm. I have sent a Pull Request to my repo which "fixes" the rendering of the checkmark. However, the fix is ​​completely unrelated. I just dropped the json from the README.

The removed json part seems harmless. I am guessing it might not be related to your README content, but rather to the rendering engine that GitHub uses.

I highly recommend that you report this strange behavior to support@github.com (possibly referring to a PR that demonstrates a potential rendering issue).

+1


source






More articles:


All Articles