## リファレンス

GitHub Markdown コールアウト

2026年3月公開

GitHubがGitHub Flavored Markdownにコールアウト（アラート）構文を追加しました。ドキュメント内の重要な情報を強調するスタイル付きボックスです — 注記、ヒント、警告など。ShowMeMyMDはこれらをレンダリングできる数少ないデスクトップビューアの一つです。

## 構文

5つのコールアウトタイプ

コールアウトはブロック引用構文に特別なタグを最初の行に付けたものです。形式は常に同じ： > [!TYPE] に続けて次の行にコンテンツを記載し、同じく >で始めます。

> [!NOTE]
> Useful information that users should know,
> even when skimming content.

NOTE — 青い情報ボックスとして表示。追加のコンテキストとして役立つが、重要度は低い情報に使用。「ちなみに」的な情報です。

> [!TIP]
> Helpful advice for doing things better
> or more easily.

TIP — 緑の提案ボックスとして表示。ベストプラクティス、ショートカット、読者の作業を楽にする推奨事項に使用。

> [!IMPORTANT]
> Key information users need to know to
> achieve their goal.

IMPORTANT — 紫の強調ボックスとして表示。先に進む前に理解すべき重要な情報に使用。警告ではないが、スキップできない内容。

> [!WARNING]
> Urgent info that needs immediate user
> attention to avoid problems.

WARNING — 黄色のアラートボックスとして表示。潜在的な問題、注意点、読者が注意しないと問題になり得ることに使用。

> [!CAUTION]
> Advises about risks or negative outcomes
> of certain actions.

CAUTION — 赤い危険ボックスとして表示。元に戻せない操作、データ損失のシナリオ、何かを壊す可能性のある操作に限定して使用。

## 使い方のコツ

コールアウトが多すぎると視覚的なノイズになります。すべてが重要なら、何も重要でなくなります。色付きボックスだらけのページは、読者にそれらを無視することを教えてしまいます。1セクションにつき1〜2個が適量です。

軽いヒントにCAUTIONを使わないこと。データベースを削除する可能性のある操作にNOTEを使わないこと。色分けは読者に重要度を瞬時に伝えるためのもの — その意味を尊重しましょう。

コールアウトは1〜3文が最適。複数の段落が必要な場合、その情報はコールアウトボックスではなく本文に記載すべきです。

コードスパン、リンク、太字、イタリックはすべてコールアウト内で使えます。すべての行を > で始めて、コールアウトブロック内にコンテンツを維持します。

## 互換性

ほとんどのMarkdownビューアは通常のブロック引用を表示するだけ。

ShowMeMyMDはフルスタイルのコールアウトをレンダリングします — カラーサイドバー、アイコン、適切なフォーマット — GitHubでの表示と同じように。READMEやドキュメントにコールアウトを書いているなら、Macでローカルにプレビューできる数少ない方法の一つです。

## 続きを読む

Mac向けMarkdownビューアとしてのShowMeMyMDの詳細や、開発者が選ぶ理由は開発者向けMarkdownビューアをご覧ください。また Markdownチートシートもブックマークしておくと便利です。

コールアウトの見た目を確認するためだけにGitHubにプッシュするのはやめましょう。ShowMeMyMDはNOTE、TIP、IMPORTANT、WARNING、CAUTIONをMac上でレンダリングします。Mac App Storeで$2.99。