Article version: GitHub.com
Article version: GitHub.com
# Markdown Editor. At GitHub, we’re building the text editor we’ve always wanted: hackable to the core, but approachable on the first day without ever touching a config file. We can’t wait to see what you build with it.
You can build tables to organize information in comments, issues, pull requests, and wikis.
In this article
Creating a table
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.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.
Formatting content within your table
You can use formatting such as links, inline code blocks, and text styling within your table:
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.To include a pipe
|
as content within your cell, use a
before the pipe:Github Md File Syntax
Further reading
Md Syntax Github Tutorial
- 'Basic writing and formatting syntax'