プロジェクトのコード管理だけでなく、ドキュメントやタスク管理にも便利な「GitHub」
GitHubは今や、“プロジェクトチームに加わったエンジニアではない人”でも使うことが増えてきているかと思います。

そこで今回は、GitHubコメント欄で使える便利な「マークダウン(※)」について紹介します。
マークダウンを使いこなすことで、GitHub上で行うコメントの内容が伝わりやすくなり、メンバーとのコミュニケーションもスムーズになるはずですよ。

※「マークダウンって何?」という方に、ものすごくざっくり説明しておくと、「とっても簡易な書き方でhtmlタグを出力してブラウザ上にキレイに表示してくれる」という記法です。

【詳しくは】Markdownとは 日本語Markdownユーザー会

GitHubで覚えておくと便利なマークダウン記法

コメント欄で使える、以下の9つのマークダウンを紹介します。

  1. テキストリンク(a)
  2. 番号なしリスト(ul)
  3. 番号付きリスト(ol)
  4. チェックボックスリスト(input type=”checkbox”)
  5. コード(code)
  6. 引用(blockquote)
  7. 太字強調(strong)
  8. 地平線(hr)
  9. 見出し(h1~h6)

1. テキストリンク(a)

URLを書けばそのままリンクに、テキストにしたい場合は
[リンクしたいテキスト]に続けて(URL)という形式で記述します。

[ウェブジェネ](https://web-generalist.com)

 

テキストリンク

ちなみに、リンクを別タブで開くための「target=”_blank”」をつけるマークダウンは2017年10月時点では無いようです。

2. チェックボックスリスト(input type=”checkbox”)

例えば、GitHubでIssue(Todoのようなもの)を登録した時に、Issueの中でもこまかなタスク・作業がある場合に使いたいのがチェックボックスリスト。

記述が少し手間ですが、以下のように書きます。
(各文字間に“半角スペース”が無いときちんと反映されないので、注意しましょう)

- [ ] チェックがない
- [x] チェックがある

 

チェックボックスリスト

ちなみにこのチェックボックスリスト、「Preview(プレビュー)」だとチェックのみができるのですが、コメント投稿したあとは以下のようにドラッグで順番の入れ替えもでき、とても便利です。

チェックボックスリストアニメGIF

さらに、Issueの最初のコメント(Issue作成時のコメント)にこのチェックボックスリストを使用すると、Issueの一覧画面などに以下のようにリストのチェック状況が表示され、進捗状況がわかります。

チェックボックスリストの状況

3. 番号なしリスト(ul)

番号なしリスト(ul)はシンプルです。
ハイフンのあとに半角スペースを忘れずに記載するようにしましょう。

- GitHub
- Slack
- Trello

 

番号なしリスト

4. 番号付きリスト(ol)

番号付きリストは、下記のように冒頭に全部「1.」と記載します。
最初は違和感がありますが、あとでリストの数が増減したり順番を入れ替えたりすると変更が手間になるので、全部「1.」で記載した方がよいでしょう。
(数字を連番で記載しても反映はされます)

1. GitHub
1. Slack
1. Trello

 

番号付きリスト

5. コードの表示(code)

コメントの中にhtmlなどのコードを書きたい時に使います。
一行の場合と複数行の場合があり、複数行の場合はコードの種類を指定すればカラーリングされます。

  1. 一行の場合のコード(code)

    「グレイヴ・アクセント(`)」でコード部分を囲みます。
    グレイヴ・アクセントはシングルクォーテション(’)と似ているのですが、全くの別物ですので注意しましょう。
    (※Shift +@で入力できます)

    ここは`color: #fff`にしてください。

     

    一行コード

  2. 複数行の場合のコード(pre code)

    複数行のコードの場合はグレイヴ・アクセント(`)を3つならべ、改行してコード部分を囲みます。
    その際、最初のグレイヴ・アクセント3つの後ろに、半角スペースとコードの拡張子を記載すれば、拡張子に対応してカラーリングされます。

    (※下記はグレイヴ・アクセント3つの後ろに「html」と記載した場合)

    ``` html
    <h2 class="cat-web"><span></span>GitHubのコメント欄で使いたい!便利なマークダウンのまとめ</h2>
    <time datetime=2017-10-05>公開日 2017.10.05</time>
    ```

     

    複数行コードhtml

    「html」を記載しない場合は下記のように、コードのカラーリングがされません。
    複数行コード 拡張子なし

6. 引用(blockquote)

引用表示にしたい場合は、先頭に大なり(>)を記載します。
メール返信などの、相手の文章を引用する文化そのままなの記載なので覚えやすいかと思います。

>進捗どうですか?

 

一行引用

また、複数行の引用をする場合は、大なり(>)はひとつだけ記載したまま、引用したい文を複数行記載します。
(改行して1行空ければそれ以降は引用されません)

>あれから進捗どうですか?
問題があれば相談していただければ一緒に解決策を考えますよ。

ありがとうございます。

 

複数行引用

7. 太字強調(strong)

文字の前後をアスタリスク(*)2つで囲むと、strongによる太字強調がされます。
コメントの中でも、重要な部分を強調して伝えたい時に使うと良いでしょう。

平野さん、issueのcloseを**忘れがちなので注意してください!**

 

太字強調

8. 地平線(hr)

アスタリスク(*)3つで、太めの地平線(hr)が挿入できます。
コメントを段落ごとなど、明確に区切りたい時に使うと良いでしょう。

セクションAについて
***
セクションBについて

 

地平線

9. 見出し(h1~h6)

シャープ(#)と半角スペースで、見出しになります。
(シャープの数が増えるほど見出しのレベルが下がります)

ただ、h4以降はむしろ通常の文字(p)より小さくなったりするので、使うシーンは少ないかもしれません。

# これはh1です。文字が一番大きく下線があります。
## これはh2です。文字が大きく下線があります。
### これはh3です。下線がなくなりました。
#### これはh4です。本文を太字にした程度の違いに見えます。
##### これはh5です。太字ですが通常の文字よりむしろ小さいレベルです。
###### これはh6です。こちらも太字ですが通常の文字よりむしろ小さいレベルです。

通常の文字はpタグでくくられます。

 

見出し

【オマケ】使えばコミュニケーションがスムーズに?スタンプ(画像)や絵文字コメント

最後にオマケとして、(マークダウンではありませんが)ブログなど様々なところで使える「Chrome拡張機能を使い“コミュニケーションがスムーズになる”画像コメントの方法」を紹介します。

「寿司ゆきスタンプ」や「いらすとや」の画像を瞬時に挿入できる「LTTM」

LTTM

上記画像のChrome拡張「LTTM」をインストールしたのち、コメント欄に「!s」と打てば「寿司ゆきスタンプ画像」が、「!i」と打てば「いらすと屋」の画像がランダムで表示されます。

その後、続けて何か文字を打てば対応したスタンプが絞り込まれて表示されます。
(以下の動画は「!st」)

寿司ゆきスタンプ画像挿入

コメント欄が殺伐とした空気にならないよう、たまにスタンプや画像を使って場を和ませることも円滑なコミュニケーションには必要かもしれませんね。

一覧表示から絵文字コードをコピーできる「Emoji Cheatsheet」

コメント欄では、「:」と任意の絵文字の頭文字を1文字打てば以下のように絵文字が表示されます。
絵文字

ただし、絵文字の名称が英語のため、慣れていないと狙った絵文字をすぐに表示することができません。

そこで、Chrome拡張機能「Emoji Cheatsheet for GitHub, Basecamp etc.(以下、Emoji Cheatsheet)」をインストールしておきます。

Emoji Cheatsheetをインストールすると以下のようにアドレスバー横にアイコンが表示されます。

Emoji Cheatsheet

アイコンをクリックすると絵文字が一覧でズラっと表示されるので、検索して選択すれば、その絵文字を表示させるコードがクリップボードへコピーされます。

絵文字の名称をある程度覚えられるまでは、「Emoji Cheatsheet」を使うと良いでしょう。


以上、「GitHubのコメント欄で使える“情報を伝えやすくするマークダウンまとめ”」をお送りしました。

ちなみに、私がこの記事で紹介した内容の多くは、以下の書籍から学びました。
(この記事で紹介した内容も概ね書いてあります)

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール

「GitHubをこれからやってみよう」という方がGitHubの概要を掴むにはとても良い本だと思いますので、興味がありましたら手にとってみると良いかと思います。
(ただし、この書籍が出た2014年10月からGitHubはアップデートされており、書籍に載っているGitHubと現状のGitHubでは見た目やリンク構成が一部変わっています)