2023-12-09 GitHub WARNING/CAUTION/NOTE/TIP/IMPORTANT記法
GitHub で Markdown を書いていて一言ハイライトで注意文であったりTipsを書きたいときに便利な記法がこちら。
※まだBeta版であるようで、記法はちょくちょく変わっていて以前の書き方は現時点で使えなくなっていることに注意。今後も安定するまでは記法が変わる可能性があるので、注意が必要。
GitHubのこの記法の最新の書き方はこう。https://t.co/XNtZtlCdaC pic.twitter.com/buRURSFWBZ
— toshimaru (@toshimaru_e) December 8, 2023
> [!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.