基本的な書き込みと書式設定の構文

見出し

見出しを作成するには、見出しテキストの前に 1 ~ 6 個の # 記号を追加します。 使用する # の数によって、見出しの階層レベルと書体のサイズが決まります。

# A first-level heading
## A second-level heading
### A third-level heading

2 つ以上の見出しを使用すると、GitHubファイル ヘッダー内の [アウトライン] メニュー アイコン をクリックしてアクセスできる目次が自動的に生成されます。 各見出しのタイトルは目次に表示され、タイトルをクリックして選択したセクションに移動できます。

テキストのスタイル設定

コメント フィールドや .md ファイルでは、太字、斜体、取り消し線、下付き文字、または上付き文字のテキストで強調を示すことができます。

Style	構文	キーボード ショートカット	Example	アウトプット
太字

          `** **` または `__ __`| 
          <kbd>Command</kbd>+<kbd>B</kbd> (Mac) または <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | `**This is bold text**` | 
          **これは太字のテキストです** |

| 斜体 | * * または _ _    | Command+I (Mac) または Ctrl+I (Windows/Linux) | _This text is italicized_ | このテキストは斜体 | | 取り消し線 | ~~ ~~ または ~ ~ | None | ~~This was mistaken text~~ | これは間違ったテキストでした | | 太字とネストされた斜体 | ** ** および _ _ | None | **This text is _extremely_ important** | このテキストは 非常に 重要です | | すべて太字と斜体 | *** *** | None | ***All this text is important*** | このテキストはすべて重要です | | 下付き | <sub> </sub> | None | This is a <sub>subscript</sub> text | これは _{下付きテキスト} です | | 上付き | <sup> </sup> | None | This is a <sup>superscript</sup> text | これは ^{上付き文字} のテキストです | | 下線 | <ins> </ins> | None | This is an <ins>underlined</ins> text | これは 下線付き テキストです |

テキストの引用

          <kbd>
          >
          </kbd>を使用してテキストを引用符で囲むことができます。

Text that is not a quote

> Text that is a quote

引用されたテキストは、左に縦線を用いてインデントされ、灰色のフォントで表示されます。

コードの引用方法

1 つのバックティックを使用して、文内でコードまたはコマンドを呼び出すことができます。 バックティック内のテキストは書式設定されません。 Command+E (Mac) または Ctrl を押すこともできます。 +E (Windows/Linux) キーボード ショートカットを使用して、コード ブロックのバックティックを Markdown 行内に挿入します。

Use `git status` to list all new or modified files that haven't yet been committed.

コードやテキストを独自で際立ったブロックにフォーマットするには、トリプルバックティックを使用します。

Some basic Git commands are:
```
git status
git add
git commit
```

詳しくは、「コードブロックの作成と強調表示」をご覧ください。

コード スニペットとテーブルを頻繁に編集する場合は、GitHub のすべてのコメント フィールドで固定幅フォントを有効にするとメリットが得られる場合があります。 詳しくは、「GitHubでの書き込みと書式設定について」をご覧ください。

サポートされているカラー モデル

問題、プルリクエスト、ディスカッションでは、バックティックを使用して文章内の色を強調することができます。 バックティックス内でサポートされているカラー モデルでは、色の視覚化が表示されます。

The background color is `#ffffff` for light mode and `#000000` for dark mode.

現在サポートされているカラー モデルを次に示します。

色	構文	Example	アウトプット
16進数	`#RRGGBB`	`#0969DA`
RGB	`rgb(R,G,B)`	`rgb(9, 105, 218)`
HSL	`hsl(H,S,L)`	`hsl(212, 92%, 45%)`

Links

インライン リンクを作成するには、リンク テキストを角かっこ [ ]で折り返し、url をかっこで囲んで ( )。 キーボード ショートカット の Command+K を使用してリンクを作成することもできます。 テキストを選択したら、クリップボードから URL を貼り付けて、選択範囲からリンクを自動的に作成できます。

テキストを強調表示し、キーボード ショートカット Command+V を使用して Markdown ハイパーリンクを作成することもできます。 テキストをリンクに置き換える場合は、キーボード ショートカット の Command+Shift+V を使用します。

This site was built using [GitHub Pages](https://pages.github.com/).

セクションのリンク

見出しがある任意のセクションに直接リンクできます。 レンダリングされたファイルで自動的に生成されたアンカーを表示するには、セクション見出しにカーソルを合わせて アイコンを表示し、アイコンをクリックしてブラウザーにアンカーを表示します。

編集中のファイル内の見出しのアンカーを決定する必要がある場合は、次の基本ルールを使用できます。

• 文字は小文字に変換されます。
• スペースはハイフン (-) に置き換えられます。 その他の空白文字または句読点文字は削除されます。
• 先頭と末尾の空白が削除されます。
• マークアップの書式設定は削除され、内容のみが残ります (たとえば、 _italics_ は italicsになります)。
• 見出しに対して自動的に生成されるアンカーが同じドキュメント内の以前のアンカーと同じ場合は、ハイフンと自動インクリメント整数を追加することで一意の識別子が生成されます。

URI フラグメントの要件の詳細については、「 RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, Section 3.5」を参照してください。

次のコード ブロックは、レンダリングされたコンテンツの見出しからアンカーを生成するために使用される基本的なルールを示しています。

# Example headings

## Sample Section

## This'll be a _Helpful_ Section About the Greek Letter Θ!
A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.

## This heading is not unique in the file

TEXT 1

## This heading is not unique in the file

TEXT 2

# Links to the example headings above

Link to the sample section: [Link Text](#sample-section).

Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-Θ).

Link to the first non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file).

Link to the second non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file-1).

相対リンク

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

相対リンクは、現在のファイルに対する相対的なリンクです。 たとえば、リポジトリのルートに README ファイルがあり、docs/CONTRIBUTING.md に別のファイルがある場合、README の CONTRIBUTING.md への相対リンクは次のようになります。

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub は相対リンクまたは画像パスを、現在のブランチに基づいて変換するので、リンクやパスは常にうまく働きます。 リンクのパスは、現在のファイルに対する相対パスになります。 / で始まるリンクは、リポジトリ ルートに対する相対パスです。 ./ や ../ のような相対リンクのオペランドをすべて使用できます。

リンク テキストは 1 行に記述する必要があります。 次の例は機能しません。

[Contribution
guidelines for this project](docs/CONTRIBUTING.md)

相対リンクは、リポジトリをクローンするユーザにも扱いやすいです。 絶対リンクはリポジトリのクローンではうまく働かないかもしれません。リポジトリ内の他のファイルを参照するには、相対リンクを使うことをおすすめします。

カスタム アンカー

標準の HTML アンカー タグ (<a name="unique-anchor-name"></a>) を使用して、ドキュメント内の任意の場所のナビゲーション アンカー ポイントを作成できます。 あいまいな参照を回避するには、 name 属性値にプレフィックスを追加するなど、アンカー タグに一意の名前付けスキームを使用します。

アンカーに指定した name 属性の値を使用して、カスタム アンカーにリンクできます。 構文は、見出しに対して自動的に生成されるアンカーにリンクする場合とまったく同じです。

例えば次が挙げられます。

# Section Heading

Some body text of this section.

<a name="my-custom-anchor-point"></a>
Some text I want to provide a direct link to, but which doesn't have its own heading.

(… more content…)

[A link to that custom anchor](#my-custom-anchor-point)

改行コード

リポジトリで問題、pull request、またはディスカッションを記述している場合、GitHub は改行を自動的にレンダリングします。

This example
Will span two lines

ただし、.md ファイルで記述している場合、上記の例は改行なしで 1 行にレンダリングされます。 .md ファイルに改行を作成するには、次のいずれかを含める必要があります。

• 最初の行の末尾に 2 つのスペースを含めます。

  This example  
  Will span two lines
  

• 最初の行の末尾にバックスラッシュを含めます。

  This example\
  Will span two lines
  

• 最初の行の末尾に HTML 単一改行タグを含めます。

  This example<br/>
  Will span two lines
  

2 行の間に空白行を残した場合、.md ファイルと Markdown の両方が問題、pull request、ディスカッションで空白行で区切られた 2 行をレンダリングします。

This example

Will have a blank line separating both lines

画像

を追加することで画像を表示できます 。 代替テキストを [ ]で折り返します。 代替テキストは、画像内の情報に相当する短いテキストです。 次に、イメージのリンクをかっこ ()で囲みます。

![Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.](https://myoctocat.com/assets/images/base-octocat.svg)

GitHub では、問題への画像の埋め込みをサポートしています。pull requests、ディスカッション、コメント、および .md ファイル。 リポジトリからイメージを表示したり、オンライン イメージへのリンクを追加したり、イメージをアップロードしたりできます。 詳細については、「 アセットのアップロード」を参照してください。

相対リンクを使用して画像を表示する例を次に示します。

Context	相対リンク
同じブランチ上の .md ファイル内	/assets/images/electrocat.png
別のブランチの .md ファイル内	/../main/assets/images/electrocat.png
リポジトリの課題、プルリクエスト、コメントにおいて	../blob/main/assets/images/electrocat.png?raw=true
別のリポジトリの .md ファイル内	/../../../../github/docs/blob/main/assets/images/electrocat.png
問題の場合は、別のリポジトリの pull request とコメント	../../../github/docs/blob/main/assets/images/electrocat.png?raw=true

詳細については、「 相対リンク」を参照してください。

Picture 要素

          `<picture>` HTML 要素がサポートされています。

Lists

1 行以上のテキストの前に -、 *、または +を付けることで、順序付けされていないリストを作成できます。

- George Washington
* John Adams
+ Thomas Jefferson

リストを並べ替える場合は、各行の前に数字を付けておきます。

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

入れ子になったリスト

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

GitHub の Web エディターまたは データ variables.product.prodname_vscode %} などのモノスペース フォントを使用するテキスト エディターを使用して入れ子になったリストを作成するには、リストを視覚的に配置できます。 リスト マーカー文字 (- または *) が、その上の項目のテキストの最初の文字のすぐ下に配置されるまで、入れ子になったリスト アイテムの前にスペース文字を入力します。

1. First list item
   - First nested list item
     - Second nested list item

モノスペース フォントを使用しない GitHub のコメント エディターで入れ子になったリストを作成するには、入れ子になったリストのすぐ上にあるリスト アイテムを確認し、アイテムのコンテンツの前に表示される文字数をカウントします。 次に、入れ子になったリスト項目の前にその数の空白文字を入力します。

この例では、入れ子になったリスト アイテムを 5 文字以上インデントすることで、リストアイテム100. First list itemの下に入れ子になったリストアイテムを追加できます。これは、100. 前に 5 文字 (First list item) があるためです。

100. First list item
     - First nested list item

同じメソッドを使用して、入れ子になったリストの複数のレベルを作成できます。 たとえば、入れ子になったリスト アイテムの先頭には、入れ子になったリスト コンテンツ␣␣␣␣␣-␣の前に 7 文字 (First nested list item) があるため、2 番目の入れ子になったリストアイテムを少なくとも 2 文字インデントする必要があります (最小 9 文字)。

100. First list item
     - First nested list item
       - Second nested list item

その他の例については、GitHub Flavored Markdown Spec を参照してください。

タスク リスト

タスク リストを作成するには、リスト アイテムの前に空白、ハイフン、[ ] を付けます。 完了したタスクをマークするには、[x] を使います。

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

タスク リスト アイテムの説明がかっこで始まる場合は、 \でエスケープする必要があります。

- [ ] \(Optional) Open a followup issue

詳しくは、「タスクリストについて」をご覧ください。

人々やチームのメンション

GitHub で、ユーザー名またはチーム名入力することで、ユーザーまたは@にメンションできます。 これにより通知がトリガーされ、会話に注意が向けられます。 ユーザー名またはチーム名をメンションするようにコメントを編集すると、ユーザーにも通知が届きます。 通知の詳細については、「通知について」を参照してください。

@github/support What do you think about these updates?

親チームに言及すると、その子チームのメンバーも通知を受け取り、複数のユーザー グループとのコミュニケーションが簡素化されます。 詳しくは、「Organization のチームについて」をご覧ください。

          <kbd>
          @
          </kbd>記号を入力すると、プロジェクトのユーザーまたはチームの一覧が表示されます。 リストは入力時にフィルター処理されるため、探しているユーザーまたはチームの名前を見つけたら、方向キーを使用して選択し、Tab キーまたは Enter キーを押して名前を完成させることができます。 チームの場合は、 @organization/team-name を入力すると、そのチームのすべてのメンバーが会話にサブスクライブされます。

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

問題と pull request の参照

「 #」と入力すると、リポジトリ内で推奨される問題とプル要求の一覧を表示できます。 問題または pull request 番号またはタイトルを入力して一覧をフィルター処理し、Tab キーまたは Enter キーを押して強調表示された結果を完了します。

詳しくは、「自動リンクされた参照と URL」をご覧ください。

外部リソースの参照

データ 再使用可能なリポジトリ.autolink-リファレンス %}

アセットのアップロード

画像などのアセットは、ドラッグ アンド ドロップ、ファイル ブラウザーからの選択、貼り付けによってアップロードできます。 リポジトリ内の問題、pull request、コメント、 .md ファイルにアセットをアップロードできます。

絵文字の使用

          `:EMOJICODE:`入力し、コロンの後に絵文字の名前を付けることで、絵文字を文書に追加できます。

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

入力 : 提案された絵文字のリストが表示されます。 入力するとリストがフィルター処理されるため、探している絵文字が見つかると、 Tab キーまたは Enter キーを押して強調表示された結果を完了します。

利用可能な絵文字とコードの完全な一覧については、 絵文字チートシートを参照してください。

段落

テキスト行間に空白行を残すことで、新しい段落を作成できます。

脚注

次の角かっこ構文を使用して、コンテンツに脚注を追加できます。

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

[^1]: My reference.
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line.  
This is a second line.

脚注は次のようにレンダリングされます。

Alerts

          **アラート** ( **吹き出し** や **警告**とも呼ばれます) は、重要な情報を強調するために使用できるブロッククォート構文に基づく Markdown 拡張機能です。 GitHub には、コンテンツの重要性を示す独特の色とアイコンが表示されます。

アラートは、ユーザーの成功に不可欠な場合にのみ使用し、読者の過負荷を防ぐために記事ごとに 1 つまたは 2 つに制限します。 さらに、アラートを連続して配置しないようにする必要があります。 アラートを他の要素内に入れ子にすることはできません。

アラートを追加するには、アラートの種類を指定する特殊なブロッククォート行を使用し、その後に標準ブロッククォート内のアラート情報を指定します。 次の 5 種類のアラートを使用できます。

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

表示されるアラートを次に示します。

コメントを含むコンテンツを非表示にする

GitHub に、HTML コメントにコンテンツを配置することで、レンダリングされた Markdown からコンテンツを非表示にすることができます。

<!-- This content will not appear in the rendered Markdown -->

マークダウンの書式設定を無視する

GitHub に、Markdown 文字の前に \ を使用してマークダウンの書式設定を無視 (またはエスケープ) するように指示できます。

Let's rename \*our-new-project\* to \*our-old-project\*.

円記号の詳細については、「Daring Fireball の マークダウン構文」を参照してください。

Markdown レンダリングの無効化

Markdown ファイルを表示するときに、ファイルの上部にある [Code] をクリックすると、Markdown レンダリングが無効になり、代わりにファイルのソースが表示されます。

Markdown レンダリングを無効にすると、ライン リンクなどのソース ビュー機能を使用できます。これは、レンダリングされた Markdown ファイルを表示する場合には使用できません。

詳細については、次を参照してください。

•         [GitHub Flavored Markdown の仕様](https://github.github.com/gfm/)
  

•         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)
  

•         [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting)
  

•         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)