ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: GitHub.com

基本的な書き方とフォーマットの構文

シンプルな構文を使い、GitHub 上で文章やコードに洗練されたフォーマットを作り出してください。

ここには以下の内容があります:

ヘッディング

ヘッディングを作成するには、1 つから 6 つの # シンボルをヘッディングのテキストの前に追加します。 使用する # の数によって、ヘッディングのサイズが決まります。

# The largest heading (最大のヘッディング)
## The second largest heading (2番目に大きなヘッディング)
###### The smallest heading (最も小さいヘッディング)

表示された H1、H2、H6 のヘッディング

スタイル付きテキスト

太字、斜体、取り消し線で強調を示すことができます。

スタイル 構文 キーボードショートカット サンプル 出力
太字 ** **もしくは__ __ command/control + b **これは太字のテキストです** これは太字のテキストです
斜体 * *あるいは_ _ command/control + i *このテキストは斜体です* このテキストは斜体です
取り消し線 ~~ ~~ ~~これは間違ったテキストでした~~ これは間違ったテキストでした
太字および太字中にある斜体 ** **及び_ _ **このテキストは_きわめて_ 重要です** このテキストはきわめて重要です
全体が太字かつ斜体 *** *** ***すべてのテキストがきわめて重要です*** すべてのテキストがきわめて重要です

テキストの引用

テキストは>で引用できます。

アブラハムリンカーンの言葉::

> フランス語で失礼します

表示された引用テキスト

ヒント: 会話を見る場合、コメントをハイライトして r と入力することで、コメント中のテキストを自動的に引用できます。 に続いて [ Quote reply] をクリックすれば、コメント全体を引用できます。 キーボードショートカットに関する詳しい情報については、「キーボードショートカット」を参照してください。

コードの引用

単一のバッククォートで文章内のコードやコマンドを引用できます。 バッククォート内のテキストはフォーマットされません。

コミットされていない新しいもしくは修正されたすべてのファイルをリストするには `git status` を使ってください。

表示されたインラインのコードブロック

独立したブロック内にコードあるいはテキストをフォーマットするには、3 重のバッククォートを使用します。

いくつかの基本的な Git コマンド:
```
git status
git add
git commit
```

表示されたコードブロック

詳しい情報についてはコードブロックの作成とハイライトを参照してください。

リンク

リンクのテキストをブラケット [ ] で囲み、URL をカッコ ( ) で囲めば、インラインのリンクを作成できます。 キーボードショートカットの command + k を使用してリンクを作成することもできます。

このサイトは [GitHub Pages](https://pages.github.com/) を使って構築されています。

表示されたリンク

参考: GitHubは、コメント中に適正な URL が書かれていれば自動的にリンクを生成します。 詳しい情報については自動リンクされた参照と URL を参照してください。

セクションのヘッディングにカーソルを置いてリンクを表示させれば、表示されたファイル中のセクションに直接リンクできます。

github/scientist リポジトリ用の README ファイル中のセクションリンク

表示されたファイル中に相対リンクや画像パスを定義すると、読者はリポジトリ中の他のファイルにアクセスしやすくなります。

相対リンクは、現在のファイルに対して相対的なリンクです。たとえば README ファイルがリポジトリのルートにあり、他のファイルを docs/CONTRIBUTING.md に持っている場合は、README 内での CONTRIBUTING.md への相対リンクは以下のようになります:

[このプロジェクトへのコントリビューションガイドライン](docs/CONTRIBUTING.md)

GitHub は、自動的に相対リンクあるいは画像パスを現在のブランチに基づいて変換するので、リンクやパスは常にうまく働きます。./../ といったすべての相対リンクのオペランドが利用できます。

相対リンクは、リポジトリをクローンするユーザにとっては使いやすいものです。絶対リンクはリポジトリのクローンではうまく働かない場合があります。リポジトリ内の他のファイルを参照する際には、相対リンクを使うことをおすすめします。

1 つ以上の行の前に - または * を置くことで、順序なしリストを作成できます。

- George Washington
- John Adams
- Thomas Jefferson

表示された順序なしリスト

リストを順序付けするには、各行の前に数字を置きます。

1. James Madison
2. James Monroe
3. John Quincy Adams

表示された順序付きリスト

入れ子になったリスト

1 つ以上のリストアイテムを他のアイテムの下にインデントすることで、入れ子になったリストを作成できます。

GitHub上の Web のエディタあるいは Atom のようなモノスペースフォントを使うテキストエディタを使って入れ子になったリストを作成するには、リストが揃って見えるように編集します。 入れ子になったリストアイテムの前に空白を、リストマーカーの文字 (- または *) が直接上位のアイテム内のテキストの一文字目の下に来るように入力してください。

1. 最初のリストアイテム
   - 最初の入れ子になったリストアイテム
   - 2 番目の入れ子になったリストアイテム

並びがハイライトされた入れ子になったリスト

2 レベルの入れ子になったアイテムを持つリスト

モノスペースフォントを使っていない GitHubのコメントエディタで入れ子になったリストを作成するには、入れ子になったリストのすぐ上にあるリストアイテムを見て、そのアイテムの内容の前にある文字数を数えます。 そして、その数だけ空白を入れ子になったリストアイテムの前に入力します。

この例では、入れ子になったリストアイテムをリストアイテム 100. 最初のリストアイテム の下に、最低 5 つの空白で入れ子になったリストアイテムをインデントさせることで追加できます。これは、最初のリストアイテムの前に 5 文字 (100.) があるからです。

100. 最初のリストアイテム
     - 最初の入れ子になったリストアイテム

入れ子になったリストアイテムを持つリスト

同じ方法で、複数レベルの入れ子になったリストを作成できます。 たとえば、最初の入れ子になったリストアイテムは内容である最初の入れ子になったリストアイテムの前に 7 つの空白 (␣␣␣␣␣-␣) があるため、2 番目の入れ子になったリストアイテムは 7 つの空白でインデントしなければならないでしょう。

100. 最初のリストアイテム
     - 最初の入れ子になったリストアイテム
       - 2 番目の入れ子になったリストアイテム

2 レベルの入れ子になったアイテムを持つリスト

GitHub Flavored Markdown の仕様には、もっと多くのサンプルがあります。

タスクリスト

タスクリストを作成するには、リストアイテムの前に通常の空白を置いて、その後に [ ] を続けます。タスクを完了としてマークするには [x] を使ってください。

- [x] 変更の完了
- [ ] コミットのGitHubへのプッシュ
- [ ] プルリクエストをオープン

表示されたタスクリスト

タスクリストアイテムの説明がカッコから始まるのであれば、 でエスケープしなければなりません。

- [ ] \(オプション) フォローアップの Issue のオープン

詳しい情報についてはタスクリストについてを参照してください。

人や Team のメンション

GitHub上の人あるいは Team は、@ に加えてユーザ名もしくは Team 名を入力することでメンションできます。 これによって通知が発生し、会話に注意してもらうことができます。 コメントを編集してユーザ名や Team 名をメンションすれば、人々に通知を受信してもらえます。

@github/support これらのアップデートについてどう思いますか?

表示された @メンション

親チームにメンションすると、その子チームのメンバーも通知を受けることになり、複数のグループの人々とのコミュニケーションがシンプルになります。 詳しい情報についてはTeam についてを参照してください。

@ シンボルを入力すると、プロジェクト上の人々あるいは Team のリストが現れます。 このリストは入力していくにつれて絞り込まれていくので、探している人あるいは Team の名前が見つかり次第、矢印キーを使ってその名前を選択し、Tab キーまたは Enter キーを押して名前の入力を完了できます。 Team については、@organization/team-name と入力すればそのチームの全メンバーにその会話をサブスクライブしてもらえます。

オートコンプリートの結果は、リポジトリのコラボレータとそのスレッドのその他の参加者に限定されます。

Issue およびプルリクエストの参照

# を入力して、リポジトリ内のサジェストされた Issue およびプルリクエストのリストを表示させることができます。 Issue あるいはプルリクエストの番号あるいはタイトルを入力してリストをフィルタリングし、Tab キーまたは Enter キーを押して、ハイライトされた結果の入力を完了してください。

詳しい情報については自動リンクされた参照と URL を参照してください。

コンテンツの添付

GitHub App には、登録されたドメインにリンクする URL に対する情報を GitHub 内で提供するものがあります。 GitHub は、アプリケーションが提供した情報を Issue あるいはプルリクエストのボディもしくはコメント中の URL の下に表示します。

コンテンツの添付

コンテンツの添付を見るには、リポジトリにインストールされた Content Attachments API を使う GitHub App が必要です。詳細は「個人アカウントでアプリケーションをインストールする」および「Organization でアプリケーションをインストールする」を参照してください。

コンテンツの添付は、Markdown のリンクの一部になっている URL には表示されません。

コンテンツの添付を利用する GitHub App の構築に関する詳しい情報については、GitHub 開発者ドキュメンテーション 内の「コンテンツの添付を使用する」を参照してください。

絵文字の利用

:EMOJICODE: を入力して、書き込みに絵文字を追加できます。

@octocat :+1: このPRは素晴らしいです - マージできますね! :shipit:

表示された絵文字

: を入力すると、絵文字のサジェストリストが表示されます。 このリストは、入力を進めるにつれて絞り込まれていくので、探している絵文字が見つかり次第、Tab または Enter を押して、ハイライトされているものを入力してください。

利用可能な絵文字とコードの完全なリストについては、emoji-cheat-sheet.comを参照してください。

パラグラフと改行

テキスト行の間に空白行を残すことで、新しいパラグラフを作成できます。

Markdown のフォーマットの無視

GitHubに対し、Markdown のキャラクタの前に を使うことで、Markdown のフォーマットを無視 (エスケープ) させることができます。

\*新しいプロジェクト\* を \*古いプロジェクト\* にリネームしましょう

表示されたエスケープキャラクタ

詳しい情報については Daring Fireball の Markdown Syntax を参照してください。

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください