Skip to main content

情報を表に編成する

表を作成して、コメント、Issue、プルリクエスト、ウィキの情報を編成できます。

テーブルの作成

パイプ (|) とハイフン (-) を使用してテーブルを作成できます。 ハイフンは各列のヘッダーの作成に使用され、パイプは各列の区切りに使用されます。 正しく表示されるように、表の前には空白行を 1 行追加してください。


| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

GitHub でレンダリングされた、幅が同じ 2 つの列を持つ Markdown のテーブルのスクリーンショット。 ヘッダーは太字でレンダリングされ、代替コンテンツの行は灰色の網掛けになっています。

表の両側のパイプ文字はオプションです。

セルの幅は変わるので、列がぴったり一致する必要はありません。 各列のヘッダ行には、ハイフンを 3 つ以上使用してください。

| Command | Description |
| --- | --- |
| git status | List all new or modified files |
| git diff | Show file differences that haven't been staged |

GitHub でレンダリングされた、幅が異なる 2 つの列を持つ Markdown のテーブルのスクリーンショット。 行には、"git status" と "git diff" というコマンドとその説明が一覧表示されています。

コード スニペットとテーブルを頻繁に編集する場合は、GitHub のすべてのコメント フィールドで固定幅フォントを有効にするとメリットが得られる可能性があります。 詳しくは、「GitHub 上での執筆とフォーマットについて」を参照してください。

表の内容をフォーマットする

表内では、リンク、インライン コード ブロック、テキスト スタイルなどの書式設定を使用できます。

| Command | Description |
| --- | --- |
| `git status` | List all *new or modified* files |
| `git diff` | Show file differences that **haven't been** staged |

GitHub でレンダリングされた、幅が異なる 2 つの列を持つ Markdown のテーブルのスクリーンショット。 コマンド "git status" と "git diff" は、コード ブロックとして書式設定されています。

ヘッダー行でハイフンの左、右、両側にコロン (:) を使うと、列でテキストを左寄せ、右寄せ、センタリングすることができます。

| Left-aligned | Center-aligned | Right-aligned |
| :---         |     :---:      |          ---: |
| git status   | git status     | git status    |
| git diff     | git diff       | git diff      |

GitHub でレンダリングされた、3 つの列を持つ Markdown のテーブルのスクリーンショット。セル内のテキストを左寄せ、中央寄せ、右寄せに設定できることを示しています。

セルでパイプ文字 (|) を使用するには、パイプ文字の前に (\) を追加します。

| Name     | Character |
| ---      | ---       |
| Backtick | `         |
| Pipe     | \|        |

GitHub でレンダリングされた Markdown のテーブルのスクリーンショット。通常、セルを閉じるパイプが、バックスラッシュを前置するとセル内に表示されることを示しています。

参考資料