Markdownには方言がある

Markdownには「これが唯一の正解」という仕様が1つだけあるわけではありません。サービスごとに少しずつ拡張されています。GitHubのものは GitHub Flavored Markdown（GFM） と呼ばれ、開発の現場でいちばんよく使われます。

タスクリスト

角括弧で作るチェックボックスです。

- [ ] 仕様を確認する
- [x] デザインを受け取る
- [ ] 実装する

GitHubのIssueやPull Requestに書くとクリックできるチェックボックスとして表示され、進捗がそのまま共有されます。[x] が完了、[ ] が未完了です。角括弧の中の半角スペースを忘れると認識されません。

打ち消し線

チルダ2つではさみます。

~~金曜締め切り~~ 月曜に延びました

決定が変わった経緯を残したいときに使います。消してしまうと、なぜ変わったのかが後から追えません。

自動リンクと相互参照

GitHubではURLを貼るだけでリンクになります。さらに #123 と書くとIssue番号へのリンクになり、@ユーザー名 で相手に通知が飛びます。

#45 の修正です。レビューを @teammate にお願いします。

方言に注意する

タスクリストや打ち消し線は、ツールによってはただの記号として表示されます。 送る先で使えるかどうかは、一度試してから本番の文書に使ってください。

• タスクリストでやることを管理する
• 打ち消し線と自動リンク
• 方言があることを知っておく