CODEWITHSUNDEEP
githubmarkdownreadme
Hesam
Hesam

Reputation: 53600

How to display Table in README.md file in Github?

I want to display a table in README.md file. I read GitHub Flavored Markdown and followed what it said.

So this is my table:

| Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11 | #12 |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269 | 254 |

However, I don't see any table and result looks like:

enter image description here

Upvotes: 170

Views: 338937

Answers (8)

Sehrish Waheed
Sehrish Waheed

Reputation: 1555

You can use this pattern to form README.md

| Header    | Heading |
| --------- | ------- |
| first     |         |
|           |         |
|           |         |
|           |         |
|           |         |
|           |         |
|           |         |

Upvotes: 6

nahidhashik
nahidhashik

Reputation: 21

You can create tables with pipes | and hyphens -. Hyphens are used to create each column's header, while pipes separate each column. You must include a blank line before your table in order for it to correctly render

follow this image

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Upvotes: 2

Fabian Zelaya
Fabian Zelaya

Reputation: 51

  • We can add three dashes (center aligned): | --- |
  • Center align with two dashes: | :---: |
  • Left align with two dashes: | :--- |
  • Right align with two dashes: | ---: |

Sample (Left align):

Collection coll = new ArrayList<>(); The ArrayList class implements the Collection interface.
coll = new TreeSet<>(); The TreeSet class also implements the Collection interface.

Upvotes: 5

Gerard Roche
Gerard Roche

Reputation: 6381

| Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11 | #12 |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269 | 254 |

Making your example shorter to make easier to understand.

| Attempt | #1    | #2    |
| :---:   | :---: | :---: |
| Seconds | 301   | 283   |

And formatted to make it even easier to read.

| Attempt | #1    | #2    |
| :---:   | :---: | :---: |
| Seconds | 301   | 283   |

Headers must be separated by pipe | characters and underlined by - dash characters. There must be at least three hyphens in each column.

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |.

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

For aesthetic purposes, you can also add extra pipes on the ends:

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

— GitHub Flavored Markdown

Our example becomes:

| Attempt | #1  | #2  |
| ------- | --- | --- |
| Seconds | 301 | 283 |

Finally, by including colons : within the header row, you can define text to be left-aligned, right-aligned, or center-aligned:

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |

— GitHub Flavored Markdown

So to center align, our example becomes:

| Attempt | #1    | #2    |
| :-----: | :---: | :---: |
| Seconds | 301   | 283   |

Upvotes: 103

Vito
Vito

Reputation: 389

Don't forget to include an empty line before the table or it won't format correctly.

Upvotes: 27

Sidd Thota
Sidd Thota

Reputation: 2249

I use the Markdown Table tool (https://www.tablesgenerator.com/markdown_tables) that helps me to import data from csv or convert my html tables into Markdown which I can simply copy it into my README.md file and it's a real timesaver for me.

I generally write things that I'm going to publish on my README file on excel file and save it as csv and import into this tool and copy paste the Generated Markdown and it creates a table that its decent for others to read your instructions.

Hope that helps.

Upvotes: 13

Spell
Spell

Reputation: 8658

You need to see documentation again. You can see this cheatsheet

In your case you need to make second line like in example below:

Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11
--- | --- | --- | --- |--- |--- |--- |--- |--- |--- |--- |---
Seconds | 301 | 283 | 290 | 286 | 289 | 285 | 287 | 287 | 272 | 276 | 269

difference between this code and your code in repo is that second line with separator has same columns as header. After that this table will be shown

Upvotes: 222

Varad Chemburkar
Varad Chemburkar

Reputation: 478

Save your readme file as README.md and not READ.ME

Upvotes: 5

Related Questions