Skip to content

About GitHub Flavored Markdown (GFM)

Jump to bottom
Yuki Koyama edited this page Jul 14, 2022 · 1 revision

GitHubで使うMarkdownについて

ここではGitHubで使えるMarkdownの文法を説明します。これを覚えればどこでもMarkdownがかけます。

なぜMarkdownが好きなのか

  • 覚えやすい
  • 文章の構造化が手軽にできる
  • いろんなところで使える

など。逆に良くないところはいわゆる「方言」が多いところかなと思います。

下記は書き方のすべてではないですが、おおよそこれさえ覚えておけばOKです。多分。

ただの改行

Markdownで改行したい場合は後ろに「半角スペースを2個」入れる必要があります。 
みなさんこんにちは(半角スペース)(半角スペース)
今日も頑張っていきましょう

上記のようにこのように書いた場合は

みなさんこんにちは
今日も頑張っていきましょう

このように改行されます。

半角スペース2つを入れなかった場合は、

みなさんこんにちは 今日も頑張っていきましょう

となってしまいます。かなり忘れやすいので注意が必要です。

段落

ただの改行とは別に「改行を2つ入れた場合」は段落になります。 
みなさんこんにちは(半角スペースなし)

今日も頑張っていきましょう

上記のように書いた場合は

みなさんこんにちは

今日も頑張っていきましょう

という感じで段落になり、半角スペースも不要です。

見出し

  • # 見出し1
  • ## 見出し2
  • ### 見出し3
  • #### 見出し4
  • ##### 見出し5
  • ###### 見出し6

これが下記のようになります

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

リスト

- みかん
- りんご
- いちご

これが下記のようになります。

  • みかん
  • りんご
  • いちご
- 果物
  - りんご
  - いちご
- 野菜
  - 苦い
    - ピーマン
  - 甘い
    - かぼちゃ
    - さつまいも

これが下記のようになります。

  • 果物
    • りんご
    • いちご
  • 野菜
    • 苦い
      • ピーマン
    • 甘い
      • かぼちゃ
      • さつまいも

ハイフンの他に、*(アスタリスク)や+(プラス)もリストに使えますが、あまり使ってる人見たことないです。
ハイフンで覚えるのがいいと思います。

番号つきリスト

1. 金メダル
1. 銀メダル
1. 銅メダル

こう書くと下記のようになります。

  1. 金メダル
  2. 銀メダル
  3. 銅メダル

順番が重要な場合は「番号つきリスト」を使用しますが、順番が重要ではないリストの場合に番号つきリストを使用することは奨励されていません。

TODOリスト

これはGitHub特有のものですが、

- [ ] 掃除する
- [ ] 洗濯する
- [ ] ランニングする

※[ ]のように半角スペースをお忘れなく。

このように書くと下記のようになります。

  • 掃除する
  • 洗濯する
  • ランニングする

TODOにチェックをつけたい場合は

- [x] 掃除する
- [x] 洗濯する
- [x] ランニングする

このようにすると、下記のようになります。

  • 掃除する
  • 洗濯する
  • ランニングする

リンク

[ここをリンクに](https://pistachiostudio.net/)

これが下記のようになります

ここをリンクに

なお、GitHubではリンクをそのまま貼るだけでハイパーリンクになってくれます。

https://pistachiostudio.net/

しかしこれはGitHubが親切設計だからです。基本的にハイパーリンクにしたい場合は

[テキスト](URL) と記述するのがいいです。

コードブロック

`(バッククウォート)で文字を囲むと

このようになります

また、```のように3つで囲むと、改行も含めた全体がコードブロックの対象になります。

こんなかんじに
全体が
なります

実はこのコードブロック、実際にコードを書く用途ではなく、
「見やすくするため」みたいな用途での使用はあまり歓迎されていないようです。

強調（太字）

*強調します*
**強調します**

これが下記のようになります

強調します
強調します

ちなみに_(アンダースコア)も使えますが、使わないほうがいい気がします。 アスタリスクで覚えちゃいましょう。

打ち消し

~打ち消します~

このように書くと

打ち消します

こうなります。

引用

> これは引用です(半角スペース)(半角スペース)
> これは引用ですこれは引用です(半角スペース)(半角スペース)
> これは引用ですこれは引用です

これが下記のようになります。

これは引用です
これは引用ですこれは引用です
これは引用ですこれは引用です

区切り線

ハイフンやアスタリスクが3つ以上連なった場合は区切り線として認識されます。

---

こうすると↓なかんじで区切り線ができる

表

表もかけますがちょっとめんどくさいです

| 重さ | 外装 | 平 | 丸 |
|---|---|---|---| 
| 500g | 袋 | 900円 | 975円| 
| 1.0kg | 袋 | 1,750円 | 1,950円| 
| 1.0kg | 箱 | 1,850円 | 2,050円| 
| 2.0kg | 袋 | 3,500円 | 3,900円|

このように書くと下記のようになる

重さ 外装 平 丸
500g 袋 900円 975円
1.0kg 袋 1,750円 1,950円
1.0kg 箱 1,850円 2,050円
2.0kg 袋 3,500円 3,900円

手書きするのはちょっと大変なのでこのようなツールを使うと楽です。

Join Pistachio Gaming Discord server!
https://discord.gg/pistachiogaming

Clone this wiki locally