2023年12月21日 更新

GitHubのMarkdownでヒントや重要、注意などのアラートを表示する方法

どうも、クラゲジュニアです。

GitHubのREADMEなどmarkdownから生成されるファイルに、以下のようなヒントを表示することが可能です。

ヒントを記述するアラート

>と[!TIP]を使って記述します。

> [!TIP]
> 物事をより良く、より簡単に行うための有益なアドバイス。

全てのアラート

全部で５種類のアラートを表示できます。

以下のmarkdownで生成可能です。

> [!NOTE]
> コンテンツをざっと読むときでも、ユーザーが知っておくべき有益な情報。

> [!TIP]
> 物事をより良く、より簡単に行うための有益なアドバイス。

> [!IMPORTANT]
> 目標を達成するためにユーザーが知っておくべき重要な情報。

> [!WARNING]
> 問題を回避するために、ユーザーの即時の注意が必要な緊急情報。

> [!CAUTION]
> 特定の行動のリスクや否定的な結果について助言する。

参考：https://docs.github.com/ja/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

以上です。