GitHub.com Enterprise Server 3.0 Enterprise Server 2.22 Enterprise Server 2.21 GitHub AE See all Enterprise releases Organizing information with tables You can build tables to organize information in comments, issues, pull requests, and wikis. GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. This formal specification, based on the CommonMark Spec, defines the syntax and semantics of this dialect.
Article version: GitHub.com
Article version: GitHub.com
You can build tables to organize information in comments, issues, pull requests, and wikis.
In this article
Creating a table
Bnt automotive. 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 Format Readme
Further reading
Github Readme Markdown Syntax
- 'Basic writing and formatting syntax'