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

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

• ヘッディング
• スタイル付きテキスト
• テキストの引用
• コードの引用
• リンク
• セクションリンク
• 相対リンク
• リスト
• タスクリスト
• 人や Team のメンション
• Referencing issues and pull requests)
• 絵文字の利用
• パラグラフと改行
• Markdown のフォーマットの無視

ヘッディング

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

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

スタイル付きテキスト

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

テキストの引用

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

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

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

コードの引用

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

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

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

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

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

リンク

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

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

セクションリンク

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

相対リンク

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

相対リンクは、現在のファイルに対する相対的なリンクです。 たとえばREADMEファイルをリポジトリのルートに置いていて、別のファイルをdocs/CONTRIBUTING.mdに置いているなら、READMeファイル中のCONTRIBUTING.mdへの相対リンクは以下のようになります。

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

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

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

リスト

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

- George Washington
- John Adams
- Thomas Jefferson

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

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

入れ子になったリスト

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

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

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

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

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

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

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

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

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

タスクリスト

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

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

If a task list item description begins with a parenthesis, you'll need to escape it with \:

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

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

人や Team のメンション

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

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

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

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

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

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

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

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

絵文字の利用

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

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

: を入力すると、絵文字のサジェストリストが表示されます。 The list will filter as you type, so once you find the emoji you're looking for, press Tab or Enter to complete the highlighted result.

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

パラグラフと改行

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

Markdown のフォーマットの無視

You can tell GitHub Enterprise to ignore (or escape) Markdown formatting by using \ before the Markdown character.

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

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

参考リンク

• GitHub Flavored Markdown の仕様
• GitHub 上での書き込みと書式設定について
• 高度なフォーマットを使用して作業する
• Markdown をマスターする