見出し

見出しを作成するには、見出しテキストの前に#記号を追加します。 使用する#の数によって、見出しのサイズが決まります。

# The largest heading## The second largest heading###### The smallest heading

テキストのスタイリング

太字、斜体、または取り消し線のテキストで強調を指定できます。

テキストの引用

>でテキストを引用することができます。,

In the words of Abraham Lincoln:> Pardon my French

ヒント：会話を表示するときは、テキストを強調表示してから、rと入力することで、コメント内のテキストを クリックしてコメント全体を引用し、返信を引用することができます。 キーボードショートカットの詳細については、”キーボードシ”

コードを引用する

あなたは、単一のバッククィックで文内のコードまたはコマンドを呼び出すことができます。 バッククィック内のテキストは書式設定されません。,

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

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

Some basic Git commands are:```git statusgit addgit commit```

詳細については、”コードブロックの作成と強調表示”を参照してください。”

Links

インラインリンクを作成するには、リンクテキストをで囲み、urlを( )で囲みます。 また、キーボードショートカットcommand + kを使用してリンクを作成することもできます。,

This site was built using (https://pages.github.com/).

ヒント：有効なUrlがコメントに書き込まれると、GitHubは自動的にリンクを作成します。 詳細については、”自動リンクされた参照とURL”を参照してください。”

セクションリンク

レンダリングされたファイル内のセクションに直接リンクするには、セクション見出しの上にマウスを置いてリンクを表示します。

相対リンク

レンダリングされたファイル内の相対リンクと画像パスを定義して、リポジトリ内の他のファイルに移動するのに役立ちます。,

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

(docs/CONTRIBUTING.md)

GitHubは、現在のブランチに基づいて相対リンクまたはイメージパスを自動的に変換し、リンクまたはパスが常に機能するようにします。 ./や../など、すべての相対リンクオペランドを使用できます。,

相対リンクは、リポジトリのクローンを作成するユーザーにとって簡単です。 リポジトリ内の他のファイルを参照するには、相対リンクを使用することをお勧めします。

Lists

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

- George Washington- John Adams- Thomas Jefferson

リストを注文するには、各行の前に数字を付けます。,

1. James Madison2. James Monroe3. John Quincy Adams

ネストされたリスト

ネストされたリストを作成するには、別の項目の下に一つ以上のリスト項目をインデントします。

GitHub上のwebエディタやAtomのような等幅フォントを使用するテキストエディタを使用してネストされたリストを作成するには、リストを視覚的に揃えることができます。 リストマーカー文字（-または*）がその上のアイテムのテキストの最初の文字のすぐ下にあるまで、ネストされたリスト,

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

等幅フォントを使用しないGitHubのコメントエディタでネストされたリストを作成するには、ネストされたリストのすぐ上にあるリストアイテムを見て、アイテムのコンテンツの前に現れる文字数を数えることができます。 次に、入れ子になったリスト項目の前にその数のスペース文字を入力します。,

この例では、リストアイテム100. First list itemの下にネストされたリストアイテムを追加することができます。First list itemの前に五つの文字()があるため、ネストされたリストアイテムをインデントすることで、ネストされたリストアイテムを最小五つのスペースでインデントすることができます。

100. First list item - First nested list item

同じメソッドを使用して、ネストされたリストの複数のレベルを作成できます。, たとえば、最初のネストされたリスト項目は、ネストされたリストコンテンツ␣␣␣␣␣-␣First nested list itemの前に七つのスペース（␣␣␣␣␣-␣）を持っているため、二つ目のネストされたリスト項目を七つのスペースでインデントする必要があります。

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

より多くの例については、GitHub Flavored Markdown仕様を参照してください。

タスクリスト

タスクリストを作成するには、リスト項目の前に通常の空白文字を付け、その後にを付けます。 タスクを完了としてマークするには、を使用します。,

- Finish my changes- Push my commits to GitHub- Open a pull request

タスクリストアイテムの説明が括弧で始まる場合は、\:

- \(Optional) Open a followup issue

詳細については、”タスクリストについて。”

人とチームに言及する

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

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

親チームに言及すると、その子チームのメンバーも通知を受け取り、複数のグループとのコミュニケーションを簡素化します。 詳細は、”チームについて”を参照してください。”

@シンボルを入力すると、プロジェクト上の人物またはチームのリストが表示されます。, リストは入力時にフィルタリングされるため、探している人またはチームの名前が見つかったら、矢印キーを使用して選択し、tabまたはenterキーを押して名前 チームの場合、@organization/team-nameを入力すると、そのチームのすべてのメンバーが会話を購読します。

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

課題とプル要求の参照

#と入力することで、リポジトリ内で推奨される課題とプル要求のリストを表示できます。, 課題またはプルリクエスト番号またはタイトルを入力してリストをフィルタリングし、tabまたはenterを押して強調表示された結果を完了します。

詳細については、”自動リンクされた参照とUrl”を参照してください。”

外部リソースの参照

リポジトリに対してカスタム自動リンク参照が構成されている場合、JIRA課題やZendeskチケットなどの外部リソースへの参照は短 リポジ, 詳細については、”外部リソースを参照する自動リンクの構成”を参照してください。”

コンテンツ添付

一部のGitHubアプリは、登録されたドメインにリンクするUrlについてGitHubで情報を提供します。 GitHubは、アプリから提供された情報を、課題やプルリクエストの本文またはコメントのURLの下にレンダリングします。

コンテンツの添付ファイルを表示するには、リポジトリにContent Attachments APIを使用するGitHubアプリがインストールされている必要があります。, 詳細については、ダイアログボックスアプリではお客様の個人アカウント”とのダイアログボックスアプリを示します。”

markdownリンクの一部であるUrlに対して、コンテンツの添付ファイルは表示されません。

コンテンツ添付ファイルを使用するGitHubアプリの構築の詳細については、”コンテンツ添付ファイルの使用”を参照してくだ”

絵文字を使用する

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

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

:と入力すると、推奨絵文字のリストが表示されます。, リストは入力時にフィルタリングされるため、探している絵文字が見つかったら、TabまたはEnterキーを押して強調表示された結果を完了します。

利用可能な絵文字とコードの完全なリストについては、Emoji-Cheat-Sheetをチェックしてください。

Paragraphs

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

Markdown書式設定を無視する

Markdown文字の前に\を使用して、Markdown書式設定を無視（またはエスケープ）するようGitHubに指示できます。,

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

詳細については、Daring Fireballの”Markdown構文”を参照してください。”

さらに読む

  • GitHub Flavored Markdown Spec
  • “GitHubでの書き込みとフォーマットについて”
  • “高度なフォーマットの操作”
  • “Markdownをマスターする”