GitHub Alerts

GitHub 形式の > [!NOTE] アラートブロック引用をアドモニションマークアップに変換します。

GitHub Alerts 機能は、GitHub 形式のアラートブロック引用（README で見かける > [!NOTE] 構文）を、アドモニションレシピ（directives マップ）が生成するのと同じアドモニションマークアップに変換します。これにより、使い慣れた GitHub 構文でコールアウトを書きながら、:::note 形式のディレクティブとまったく同じように描画できます。

// zfb.config.ts export default defineConfig({ markdown: { features: { githubAlerts: true, }, }, });

構文

ブロック引用の 1 行目に [!TYPE] を前置します（タイプは大文字小文字を区別せずに一致）。

> [!NOTE]
> ユーザーが流し読みしていても知っておくべき有用な情報。

バリアント

5 種類のアラートタイプがサポートされています。それぞれがアドモニションバリアントに対応します。

ライブデモ

以下に 5 つのバリアントすべてをライブで描画しています。

出力されるマークアップ

出力はアドモニションレシピ（directives マップ）と同一です。たとえば > [!NOTE] は次を生成します。

<div data-admonition="note" class="admonition admonition-note">
  <p class="admonition-title">…</p>
  <div class="admonition-body">…</div>
</div>

メモ

• サポートされる構文は [!TYPE] のみです。> [!NOTE] My Title のように末尾にインラインタイトルを付けると、アラートではなく通常のブロック引用として扱われます。

• 複数段落がサポートされ、すべての本文がアドモニション内に収まります。

• GitHub Alerts とアドモニションレシピ（directives マップ）は共存します。GitHub アラートはアドモニションパスより前に処理されるため、両方を同時に有効化できます。