GitHub.com で利用できる Markdown 記法のアラートは、これまで [!Note]
・[!Warning]
と 2023 年 7 月 23 日 に追加された [!Important]
がありました。
このアラート記法は断続的に更新されており、2023 年 11 月 14 日にいくつかの重要な変更がなされました。
本記事では、これらの変更を紹介します。
アラート記法は 2023 年 12 月 14 日に正式にリリースされました
追加されたアラート
2023 年 11 月 14 日に、これまでのアラートに [!Tip]
と [!Caution]
が追加されました
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
他の構文とのネスト
これまでアラート記法内で他の構文を利用すると、一部の構文は利用できないバグが生じていました。
今回の更新では、これらのバグのいくつかが解消され、ブロッククォート等によるネストと同じように動作するようになりました。
ただし、Fenced code block のシンタックスハイライトは機能しない等のバグは残されています。バグが解消されることを期待しましょう。
一方で、アラート記法は他の構文にネストされません。すなわち、以下の構文内でアラート記法を利用することが出来ません。
- ブロッククォート
- リスト(箇条書き、番号付き、タスクリスト)
- 脚注
例えば、次のような書き方が出来ません。
> ここはブロッククォートです。
>
> > [!NOTE]
> > ここはブロッククォート内のアラートです。
他の構文にネストされない仕様には 反対意見 がなされており、更新に伴って仕様変更される可能性があります。
廃止された記法
アラート記法は β 版公開当初、アラートタグを **Note**
のようにしていました。
今回の更新以降、この強い強調 (**
) によるアラートタグは利用できなくなりました。もしも、この記法を使っている場合は気を付けてください。
この記法は 2023 年 6 月 21 日の更新で、近いうちに使えなくなることが予告されていました。
余談
今回の更新で追加されたアラート種 [!Tip]
と [!Caution]
によって、アラート記法の表現は Microsoft Learn の Alerts と同等になりました。
アラート記法の更新に関する情報は、以下の Discussion のみで公開されています。