アドモニション

7つの種類で重要な情報を強調するためのコールアウトブロック。

アドモニションは重要な情報を強調するためのコールアウトブロックです。7種類すべてがグローバルに利用可能で、インポートは不要です。

Note

:::note
これはNoteです。一般的な情報やヒントの表示に使用します。
:::

:::note[カスタムタイトル]
Noteは読者が見逃すべきでない重要な情報を強調するのに適しています。
:::

Tip

:::tip
これはTipです。便利な提案やベストプラクティスの紹介に使用します。
:::

:::tip[便利なヒント]
キーボードショートカットを使うと作業を効率化できます。
:::

Info

:::info
これはInfoブロックです。追加のコンテキストや背景情報の提供に使用します。
:::

:::info[豆知識]
この機能はバージョン2.0で導入されました。
:::

Warning

:::warning
これはWarningです。潜在的な問題や注意すべき点のフラグに使用します。
:::

:::warning[非推奨のお知らせ]
このAPIは次のメジャーバージョンで削除されます。新しいAPIへの移行をお願いします。
:::

Danger

:::danger
これはDangerアラートです。データ損失や破壊的変更に関する重大な警告に使用します。
:::

:::danger[破壊的変更]
このコマンドを実行すると、すべてのデータが完全に削除されます。この操作は取り消せません。
:::

Caution

:::caution
これはCautionです。慎重な対応が必要なリスクのある操作に使用します。
:::

:::caution[慎重に進めてください]
このマイグレーションを実行する前にデータをバックアップしてください。
:::

Important

Important には :::important ディレクティブがありません — 下記のJSXコンポーネント構文か、GitHub Alertsの > [!IMPORTANT] 構文を使用してください。

<Important>
これはImportantです。読者が目的を達成するために知っておくべき重要な情報に使用します。
</Important>

<Important title="最初にお読みください">
アップグレード前に移行ガイドを確認してください。
</Important>

コンポーネント構文

上記のディレクティブ構文に加えて、JSXコンポーネント構文も使用できます。より細かい制御が必要な場合やカスタムレイアウトを構築する場合に便利です。

<Note>
デフォルトタイトルのNote。
</Note>

<Warning title="注意">
カスタムタイトル付きのWarning。
</Warning>

コンポーネント構文は7種類すべて（Note、Tip、Info、Warning、Danger、Caution、Important）とオプションの title プロップをサポートしています。

プロップ

カラーリファレンス

各アドモニションタイプは、ボーダーとタイトルの色にセマンティックカラートークンを使用しています：