Menu
Article version: GitHub.com
May 16, 2019 The extension.md stands for Markdown which is a lightweight markup language with plain text formatting syntax. It’s a very simple language used to create beautiful and presentable readme files for. A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about. Why should I make it? It's an easy way to answer questions that your audience will likely have regarding how to install and use your project and also how to collaborate with you. The extension.md stands for Markdown which is a lightweight markup language with plain text formatting syntax. It’s a very simple language used to create beautiful and presentable readme files for.
Article version: GitHub.com
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
Github Readme File Template
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 Readme File Link
Further reading
Github Readme Template
- 'Basic writing and formatting syntax'