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.
| First Header | Second Header | | ------------- | ------------- | | Content Cell | Content Cell | | Content Cell | Content Cell |
The pipes on either end of the table are optional.
Cells can vary in width and do not need to be perfectly aligned within columns. There must be at least three hyphens in each column of the header row.
| Command | Description | | --- | --- | | git status | List all new or modified files | | git diff | Show file differences that haven't been staged |
If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub. For more information, see "About writing and formatting on GitHub."
You can use formatting such as links, inline code blocks, and text styling within your table:
| Command | Description | | --- | --- | | `git status` | List all *new or modified* files | | `git diff` | Show file differences that **haven't been** staged |
You can align text to the left, right, or center of a column by including colons
: to the left, right, or on both sides of the hyphens within the header row.
| Left-aligned | Center-aligned | Right-aligned | | :--- | :---: | ---: | | git status | git status | git status | | git diff | git diff | git diff |
To include a pipe
| as content within your cell, use a
\ before the pipe:
| Name | Character | | --- | --- | | Backtick | ` | | Pipe | \| |