d9167f1449
* chore: Add missing code fence languages * Update content/actions/creating-actions/dockerfile-support-for-github-actions.md * Add raw & endraw markers around shell content See review comment by @rachmari * Add raw & endraw markers around shell content See review comment by @rachmari * Remove language from code fences to avoid the problem of replaceable text indicates like <this> not showing up in the output page. Co-authored-by: hubwriter <hubwriter@github.com>
78 lines
2.7 KiB
Markdown
78 lines
2.7 KiB
Markdown
---
|
|
title: Organizing information with tables
|
|
intro: 'You can build tables to organize information in comments, issues, pull requests, and wikis.'
|
|
redirect_from:
|
|
- /articles/organizing-information-with-tables
|
|
versions:
|
|
free-pro-team: '*'
|
|
enterprise-server: '*'
|
|
github-ae: '*'
|
|
---
|
|
|
|
### 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.
|
|
|
|
```markdown
|
|
|
|
| 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.
|
|
|
|
```markdown
|
|
| Command | Description |
|
|
| --- | --- |
|
|
| git status | List all new or modified files |
|
|
| git diff | Show file differences that haven't been staged |
|
|
```
|
|
|
|
|
|
|
|
### Formatting content within your table
|
|
|
|
You can use [formatting](/articles/basic-writing-and-formatting-syntax) such as links, inline code blocks, and text styling within your table:
|
|
|
|
```markdown
|
|
| 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.
|
|
|
|
```markdown
|
|
| 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:
|
|
|
|
```markdown
|
|
| Name | Character |
|
|
| --- | --- |
|
|
| Backtick | ` |
|
|
| Pipe | \| |
|
|
```
|
|
|
|
|
|
|
|
### Further reading
|
|
|
|
- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
|
|
- "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"
|