2023年11月21日 追記:
初回投稿時(2022年6月)の内容を,2023年11月現在の内容に更新しました
はじめに
Qiitaの:::note
みたいな強調表示とは,上のような表示(コールアウト)のこと
Qiitaでは :::note info
や :::note warn
などと入力すると強調して表示ができる
GitHubでの対応状況
2023年11月現在,5種類の表示が利用できる
[Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta)
というわけで試してみた.
使い方
IssueなどのMarkdownに,以下のような記法で書き込む
> [!NOTE]
> こんな感じに書き込むと強調表示される
> [!TIP]
> `TIP` の例
> [!IMPORTANT]
> `IMPORTANT` の例
> [!WARNING]
> `WARNING` の例
> [!CAUTION]
> `CAUTION` の例
見ての通り,従来の Markdown 記法の引用をベースに使える便利機能になっている
Obsidian の Callouts 機能に似ている気がする
おわりに
頻繁にアップデートが行われているため,今後も変更があるかも
(実際に,この記事の初回投稿時に紹介していた記法が今では機能しなくなったりしている)
とはいえ,消えても通常のMarkdown構文として機能するので大きな問題はないと思う