Search code examples
githubmarkdowngithub-flavored-markdown

How to draw checkbox or tick mark in GitHub Markdown table?


I am able to draw checkbox in Github README.md lists using

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

But this is not working in table. Does anybody know how to implement checkbox or checkmark in GitHub Markdown table?


Solution

  • Try adding a - before the [ ] or [x]. That's an - followed by a blank space . An unchecked box also need a space between the brackets.

    Below is an example from Github blog.

    ### Solar System Exploration, 1950s – 1960s
    
    - [ ] Mercury
    - [x] Venus
    - [x] Earth (Orbit/Moon)
    - [x] Mars
    - [ ] Jupiter
    - [ ] Saturn
    - [ ] Uranus
    - [ ] Neptune
    - [ ] Comet Haley
    

    It appears like below:

    Resultant Image

    Here's how one could do the same in a table:

    | 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
    

    Here's how it looks:

    enter image description here