GitHub
Markdown
translation

翻訳 GitHub Help - Markdown Basics

More than 3 years have passed since last update.

この翻訳について

  • 翻訳対象 Markdown Basics - User Documentation
  • とても意訳
  • 非エンジニア向け Github 布教用
  • 日本人 非エンジニア向け が目的なので、例文や説明を勝手に編集してるところがあります。

始めに

  • 半角スペースや改行のある/なしによって意味が変わってくるので、慣れないうちはスペースと改行に注目
  • 半角文字と全角文字は違う文字です
    • もし全角で変換する必要のあるシーンが普段から少ないのであれば、IME の設定で以下の文字は全て半角にしてしまうと Markdown を書くには便利です
      • スペース
      • 数字
      • # . > * + - ^ [ ] ( )
      • ` (バッククォート)

Markdown の基本

Markdown は、プレインテキストのままで「読みやすく」「書きやすい」フォーマットで、 GitHub 上で閲覧するときには正しい HTML に変換されて表示されます。

基本の書き方

段落 Paragraphs

Markdown の段落は、単一 または 複数の行にわたる連続したテキストに、ひとつ以上の改行をつけて表します。

段落(だんらく、英語:paragraph)とは文章における1ブロックのことであり、通常は複数の文によって構成される。パラグラフとも呼ばれる。

段落を表す記号として「段落記号(¶)」が存在する。

見出し Headings

見出しのテキストとなる行の頭に、 ひとつ以上の # をつけることで見出しとします。
# の数に応じて見出しのレベルを決めることができます。

# 最も大きい、見出しレベル 1 (<h1> タグ相当)
## 見出しレベル 2 (<h2> タグ相当)
    :
    : (中略)
    :
###### 最も小さい、見出しレベル 6 (<h6> タグ相当)

(勝手に追記) # のあとに半角スペースを入れて書き始める必要があるため、注意してください。

引用 Blockquotes

引用は > を使って表します。

今日こういう提案あったんですが、どうですか

> 明日社内でうどん打ちませんか
> またはたこ焼き

(勝手に追記) > のあとに半角スペースを入れて書き始める必要があるため、注意してください。

テキストのスタイリング

ボールド、イタリック(斜体)も可能です。

*これはイタリック体になります*
**このテキストは太字になります**

ボールド、イタリックともに、 * だけでなく _ を代わりに利用できます。
これはつまり、必要に応じてボールド + イタリックも可能ということです。

**今日の夕方5時からのうどんミーティングは全員 _参加必須_ です**

今日の夕方5時からのうどんミーティングは全員 参加必須 です

リスト

番号なしリスト Unordered lists

番号なしリストは、 *- のどちらかをリストアイテムの行頭に書きます。

* リストアイテム
* リストアイテム
* リストアイテム

- Item
- Item
- Item

番号つきリスト Ordered lists

番号付きリストは、リストアイテムの行頭を数字で始めます。

1. Item 1
2. Item 2
3. Item 3

(勝手に補足) 任意の数字 . 半角スペース を続けて入力します。

階層化されたリスト

リストアイテムを 2 スペースでインデントすることで、階層化されたリストにすることができます。


1. アイテム 1
  1. アイテム 1 の子アイテム
  2. アイテム 1 の子アイテム
2. アイテム 2
  * 番号付きリストの子アイテムは、必ずしも番号付きでなくても良い
    * さらに階層が深くなったため、このアイテムは合計 4 スペース分インデントされています
3. アイテム 3
  1. アイテム 1
    1. アイテム 1 の子アイテム
    2. アイテム 1 の子アイテム
  2. アイテム 2
    • 番号付きリストの子アイテムは、必ずしも番号付きでなくても良い
      • さらに階層が深くなったため、このアイテムは合計 4 スペース分インデントされています
  3. アイテム 3

(勝手に補足) 標準の Markdown ではリストの階層化を 4 スペースで書きます。Qiita の Markdown の場合、2階層目までは 2 スペース、3階層目以降 4 スペース (合計6スペース) 必要ぽい。

コードフォーマット

行内のコードフォーマット

行内のテキスト、つまりインラインテキストの一部を等幅フォントで表示する場合には、次の例のようにバッククォート ( ` ) を使います。
バッククォートで囲まれたテキストは、見た目通りに表示され、テキストのスタイリングは適用されなくなります。


Dropbox に `documents/markdown/cheatsheet.md` を追加したのでよかったら見てください。

Markdown で **太字** は `**太字**` と書きます。

Dropbox に documents/markdown/cheatsheet.md を追加したのでよかったら見てください。

Markdown で 太字**太字** と書きます。


複数行のコードフォーマット

複数行にわたる段落をコードとして等幅フォントで表示するには、 次のようにバッククォートを 3 つ重ねます。

```
x = 0
x = 2 + 2
what is x
```

リンク

リンクを作成するには、リンクのテキストを [ ] で囲み、続けて URL を ( ) で囲みます。

例として、 https://github.com/ へのハイパーリンクを、 「GitHub を始めよう!」というテキストで作成する場合、 [GitHub を始めよう!](https://github.com/) のように書きます。

これは GitHub を始めよう! のように表示されます。

その他の参考ドキュメント