こんにちは、CX 事業本部 Delivery 部の若槻です。
先日に GitHub で Alert（アラート） というマークダウン拡張の記法が新しく使えるようになりました。
使用できるアラート記法は 5 種類で、次のように記述をします。
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.これによりドキュメント等でメッセージを強調することができます。
ドキュメントはこちらです。
Saved replies ですぐ呼び出せるようにする
さて、このアラート記法を使いたいときに、何も見ずに記述をする自信は私にはありません。かと言って度々チートシート的なものを見るのも面倒です。
そのような時は GitHub の Saved replies を使うと便利です。これにより予め用意したテンプレートを呼び出すことができます。
https://github.com/settings/replies より 5 つの記法を作成しておきます。
すると、Issue や Pull Request のコメント欄でボタンクリック（またはスラッシュコマンド）により Saved replies のテンプレート一覧を表示できます。
選択したテンプレートがコメント欄に挿入されます。
これで 5 種類のアラート記法を覚えておく必要はありませんね！
おわりに
GitHub で新しく使えるようになったアラート記法を Saved replies ですぐ呼び出せるようにしてみました。
アラート記法を利用すれば GitHub でのドキュメントの表現力が大きく向上するので、使いこなすためにも Saved replies でテンプレートを作成しておくと良いでしょう。
参考
以上
5
