How to Make a Table in Markdown

To create a table in Markdown, you can use a simple syntax that is supported by GitHub Flavored Markdown (GFM) and many modern Markdown renderers. While tables are not part of the original or CommonMark specifications, they are widely supported on platforms like GitHub and GitLab.

Basic Table Structure

The basic structure of a Markdown table includes:

1. A header row with cells separated by pipes (|).
2. A separator row with dashes (---) to define each column.
3. One or more rows of data, with cells separated by pipes.

Here is a simple example of a 2-column table:

| Name  | Age |
|-------|-----|
| Alice | 30  |
| Bob   | 25  |

Alignment in Tables

Alignment of text within table columns is controlled by colons (:) in the separator row:

• :--- for left alignment
• :---: for center alignment
• ---: for right alignment

Here is an example of a table with different alignments:

| Left-aligned | Centered | Right-aligned |
|:-------------|:--------:|--------------:|
| Alice        | 30       | 1000          |
| Bob          | 25       | 2000          |

Note that the outer pipes are optional but improve readability. Columns do not need to align in the source code, but aligning them makes the Markdown more readable.

To include a literal pipe inside a cell, escape it with a backslash (\|). For example:

| Name   | Comment          |
|--------|------------------|
| Charlie| This is a \| pipe |

Cells cannot contain raw line breaks. If you need a line break within a cell, you can use the HTML <br> tag if the renderer supports it.

A full worked example

Here is a complete example of a Markdown table with three columns, demonstrating left, center, and right alignment:

| Left-Aligned | Center-Aligned | Right-Aligned |
| :----------- | :------------: | ------------: |
| Apples       | 5              | $1.00         |
| Bananas      | 3              | $0.60         |
| Cherries     | 7              | $2.50         |

Where Markdown tables render

Markdown tables, especially those following the GitHub Flavored Markdown (GFM) specification, are widely supported in various platforms and tools. Here are some common environments where you can expect Markdown tables to render correctly:

• GitHub: Fully supports GFM tables in issues, pull requests, and README files.
• GitLab: Also supports GFM tables in issues, merge requests, and documentation.
• VS Code Preview: The built-in Markdown preview in Visual Studio Code renders GFM tables accurately.
• Static-site generators: Many static-site generators like Jekyll, Hugo, and Eleventy support GFM tables when using appropriate Markdown plugins.

However, it’s important to note that not all Markdown renderers support tables, especially those that adhere strictly to the CommonMark specification. Therefore, it’s advisable to preview your Markdown content in the target environment before publishing to ensure that tables are rendered as expected.

Common table problems and fixes

When working with tables in Markdown, you may encounter some common issues. Here are a few problems and their solutions:

Generating tables from data

Creating tables manually in Markdown can be tedious, especially for large datasets. Fortunately, many editors and tools can automate this process:

• CSV to Markdown: Many tools can convert CSV (Comma-Separated Values) files into Markdown tables. This is useful for exporting data from spreadsheets or databases.
• TSV to Markdown: Similar to CSV, TSV (Tab-Separated Values) files can also be converted into Markdown tables. This is helpful for data that uses tabs as delimiters.
• Markdown table generators: Online and offline tools are available that allow you to input data and generate the corresponding Markdown table syntax. Some editors also have plugins or built-in features for this purpose.
• Scripting: For those comfortable with scripting, writing a simple script to convert data into Markdown table format is also an option. This can be done in languages like Python, JavaScript, or Ruby.

Using these tools and methods can save time and reduce errors when creating Markdown tables from existing data sources.

Using QuikConsole for Markdown Tables

You can easily create and preview Markdown tables using the Markdown preview tool in QuikConsole. This tool runs in your browser and does not upload your data, ensuring your privacy. It provides a real-time preview of your Markdown, making it easy to see how your table will render.

Markdown Syntax Guide

For more detailed information on Markdown syntax, including tables and other features, refer to the Markdown syntax guide.

Alignment and formatting inside cells

Markdown tables support basic inline formatting and alignment within individual cells. While block-level elements like lists do not work, you can use inline styles to enhance your table content:

• Bold text: Use double asterisks **bold** to make text bold.
• Italic text: Use single asterisks *italic* or underscores _italic_ for italics.
• Code: Use backticks `code` to format text as code.
• Links: Enclose the link text in brackets [ ] followed by the URL in parentheses ( ).

Alignment of text within cells is controlled by the colons : used in the separator row:

• Left-aligned: : at the start of the separator, e.g., |:---
• Center-aligned: : at both start and end, e.g., |:---:|
• Right-aligned: : at the end, e.g., ---:|

For example:

| Left-aligned | Center-aligned | Right-aligned |
| :----------- | :------------: | ------------: |
| **Bold**    | `code`         | [Link](http://example.com) |
| *Italic*    | Text           | More text     |

Preview before you commit

Before finalizing your Markdown table, it is crucial to ensure that it renders correctly. The most common issue is an incorrectly formatted separator row, which can cause the table to display as plain text. To avoid this:

1. Use the QuikConsole Markdown Preview tool: Paste your Markdown content into the Markdown Preview tool to see a live rendering of your table.
2. Check the separator row: Ensure that the separator row contains at least three dashes - for each column and that the colons : are correctly placed for alignment.
3. Verify the number of columns: The number of dashes in the separator row should match the number of columns in your table header.
4. Test with different content: Try different types of content in your cells, including inline formatting, to ensure that everything displays as expected.

By following these steps, you can confirm that your table will render correctly and look professional in any Markdown-supported environment.

Frequently asked questions

Are Markdown tables part of the original Markdown specification?

No, Markdown tables are a GitHub Flavored Markdown (GFM) extension and are not part of the original or CommonMark specifications.

What is the syntax for creating a basic Markdown table?

A basic Markdown table consists of a header row with cells separated by pipes (|), a separator row with dashes (—), and rows of data with cells separated by pipes.

How do I align text within a table column in Markdown?

Alignment is controlled by colons in the separator row: :— for left, :—: for center, and —: for right alignment.

Can I include a pipe character inside a table cell?

Yes, to include a literal pipe inside a cell, escape it with a backslash (\|).

Are there any limitations on what can be included in a table cell?

Yes, cells cannot contain raw line breaks. If you need a line break within a cell, you can use the HTML <br> tag if the renderer supports it.