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

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

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

ヘッディング

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

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

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

スタイル付きテキスト

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

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

テキストの引用

You can quote text with a >.

Text that is not a quote

> Text that is a quote

表示された引用テキスト

Tip: When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing R. に続いて [ Quote reply] をクリックすれば、コメント全体を引用できます。 キーボードショートカットに関する詳しい情報については、「キーボードショートカット」を参照してください。

コードの引用

単一のバッククォートで文章内のコードやコマンドを引用できます。 The text within the backticks will not be formatted. You can also press the Command+E (Mac) or Ctrl+E (Windows/Linux) keyboard shortcut to insert the backticks for a code block within a line of Markdown.

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

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

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

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

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

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

If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub Enterprise Cloud. For more information, see "Enabling fixed-width fonts in the editor."

リンクのテキストをブラケット [ ] で囲み、URL をカッコ ( ) で囲めば、インラインのリンクを作成できます。 You can also use the keyboard shortcut Command+K to create a link. When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.

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

表示されたリンク

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

セクションのヘッディング上にカーソルを移動させてリンクを表示させることにより、表示されたファイル中のセクションに対して直接リンクできます。

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

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

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

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

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

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

Images

You can display an image by adding ! and wrapping the alt text in [ ]. Then wrap the link for the image in parentheses ().

![This is an image](https://myoctocat.com/assets/images/base-octocat.svg)

Rendered Image

GitHub Enterprise Cloud supports embedding images into your issues, pull requests, discussions, comments and .md files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see "Uploading assets."

Tip: When you want to display an image which is in your repository, you should use relative links instead of absolute links.

Here are some examples for using relative links to display an image.

コンテキストRelative Link
In a .md file on the same branch/assets/images/electrocat.png
In a .md file on another branch/../main/assets/images/electrocat.png
In issues, pull requests and comments of the repository../blob/main/assets/images/electrocat.png
In a .md file in another repository/../../../../github/docs/blob/main/assets/images/electrocat.png
In issues, pull requests and comments of another repository../../../github/docs/blob/main/assets/images/electrocat.png?raw=true

Note: The last two relative links in the table above will work for images in a private repository only if the viewer has at least read access to the private repository which contains these images.

For more information, see "Relative Links."

Specifying the theme an image is shown to

You can specify the theme an image is displayed to by appending #gh-dark-mode-only or #gh-light-mode-only to the end of an image URL, in Markdown.

We distinguish between light and dark color modes, so there are two options available. You can use these options to display images optimized for dark or light backgrounds. This is particularly helpful for transparent PNG images.

コンテキストURL
Dark Theme![GitHub Light](https://github.com/github-light.png#gh-dark-mode-only)
Light Theme![GitHub Dark](https://github.com/github-dark.png#gh-light-mode-only)

リスト

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

- George Washington
- John Adams
- Thomas Jefferson

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

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

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

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

入れ子になったリスト

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

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

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

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

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

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

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

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

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

同じ方法で、複数レベルの入れ子になったリストを作成できます。 For example, because the first nested list item has seven characters (␣␣␣␣␣-␣) before the nested list content First nested list item, you would need to indent the second nested list item by seven spaces.

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

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

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

タスクリスト

To create a task list, preface list items with a hyphen and space followed by [ ]. タスクを完了したとマークするには[x]を使ってください。

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

表示されたタスクリスト

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

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

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

人や Team のメンション

GitHub Enterprise Cloud上の人あるいは Team は、@ に加えてユーザ名もしくは Team 名を入力することでメンションできます。 これにより通知がトリガーされ、会話に注意が向けられます。 コメントを編集してユーザ名や Team 名をメンションすれば、人々に通知を受信してもらえます。 通知の詳細は、「通知について」を参照してください。

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

表示された @メンション

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

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

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

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

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

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

外部リソースの参照

カスタムの自動リンク参照がリポジトリに設定されているなら、JIRAのIssueやZendeskのチケットのような外部リソースへの参照は、短縮リンクに変換されます。 リポジトリで利用できる自動リンクを知るには、リポジトリの管理権限を持つ人に連絡してください。 詳しい情報については「外部リソースを参照する自動リンクの設定」を参照してください。

アセットをアップロードする

ドラッグアンドドロップ、ファイルブラウザから選択、または貼り付けることにより、画像などのアセットをアップロードできます。 アセットをリポジトリ内の Issue、プルリクエスト、コメント、および .md ファイルにアップロードできます。

絵文字の利用

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

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

表示された絵文字

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

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

パラグラフ

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

Footnotes

You can add footnotes to your content by using this bracket syntax:

Here is a simple footnote[^1].

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

You can also use words, to fit your writing style more closely[^note].

[^1]: My reference.
[^2]: Every new line should be prefixed with 2 spaces.  
  This allows you to have a footnote with multiple lines.
[^note]:
    Named footnotes will still render with numbers instead of the text but allow easier identification and linking.  
    This footnote also has been made with a different syntax using 4 spaces for new lines.

The footnote will render like this:

Rendered footnote

Note: The position of a footnote in your Markdown does not influence where the footnote will be rendered. You can write a footnote right after your reference to the footnote, and the footnote will still render at the bottom of the Markdown.

Hiding content with comments

You can tell GitHub Enterprise Cloud to hide content from the rendered Markdown by placing the content in an HTML comment.

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

Markdown のフォーマットの無視

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

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

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

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

Disabling Markdown rendering

When viewing a Markdown file, you can click at the top of the file to disable Markdown rendering and view the file's source instead.

Display Markdown as source

Disabling Markdown rendering enables you to use source view features, such as line linking, which is not possible when viewing rendered Markdown files.

参考リンク