CODEWITHSUNDEEP
githubmarkdowngithub-flavored-markdown
William Ross
William Ross

Reputation: 3910

GitHub readme markdown to include bullet points inside of table

I am trying to put bullet points inside of a GitHub text box for the READme.

I know how to do them separately. For example to create the gray textbox I can do:

```
item1
item2
```

To create bullet points I can do:

* item1
* item2

However if I try and place the bullet points inside of the table, the literal syntax for the bullet points shows up, rather than the bullet points. I have tried escaping the bullet point characters.

How do I get bullet points inside of the table?

Upvotes: 4

Views: 9191

Answers (2)

hal9kaye
hal9kaye

Reputation: 33

You could perhaps fudge it by using a html line break in the table cell, i.e.

</br>

which works for me.

Upvotes: 0

Waylan
Waylan

Reputation: 42497

The GitHub Flavored Markdown Spec plainly states:

Block-level elements cannot be inserted in a table.

Of course, lists are block-level elements, and therefore they cannot be inserted in a table.

Generally the way to get around such restrictions in Markdown is to use raw HTML. However, a raw HTML list would be a HTML block, which is also a block-level element and not allowed in a table. Therefore, you would need to use raw HTML for the entire table.

Upvotes: 5

Related Questions