Callout の使い方
注意喚起や補足を目立たせる Callout の書き方と使い分け。
Callout は、読者に気づいてほしい情報を視覚的に強調するブロックです。GitHub Flavored Markdown の > [!TYPE] 記法を採用しています。
5 種類のタイプ
NOTE — 補足
> [!NOTE]
> ここは読み飛ばしても本筋には影響しない補足情報です。メモ
ここは読み飛ばしても本筋には影響しない補足情報です。
TIP — ヒント
> [!TIP]
> 知っておくと便利な小ワザ。ヒント
知っておくと便利な小ワザ。
IMPORTANT — 重要
> [!IMPORTANT]
> 必ず読んでほしい情報。飛ばすと失敗します。重要
必ず読んでほしい情報。飛ばすと失敗します。
WARNING — 注意
> [!WARNING]
> この操作には注意が必要です。注意
この操作には注意が必要です。
CAUTION — 警告
> [!CAUTION]
> 取り返しがつかない可能性があります。本当に実行しますか。警告
取り返しがつかない可能性があります。本当に実行しますか。
使い分けのガイドライン
| タイプ | いつ使う | 例 |
|---|---|---|
| NOTE | 本筋の補強 | 「ちなみに」「なお」 |
| TIP | ワンランク上の使い方 | 「高速化するには」 |
| IMPORTANT | 必読の前提 | 「始める前に SSH 鍵を用意してください」 |
| WARNING | ミスしやすい操作 | 「--force は履歴を書き換えます」 |
| CAUTION | 不可逆な操作 | 「本番 DB を TRUNCATE します」 |
複数行の本文
行頭の > を続けることで複数行の callout が書けます。
> [!NOTE]
> 複数行の場合は、各行の先頭に > を付けます。
> 空行を入れたい場合は > だけの行を挟みます。メモ
複数行の場合は、各行の先頭に > を付けます。
空行を入れたい場合は > だけの行を挟みます。
使いすぎに注意
注意
Callout は「目が止まる」から効果があります。1 ページに 5 箇所も 6 箇所も入れると、どれも目立たなくなります。目安は 1 ページに 1〜3 個です。
前のページ
← カスタマイズ次のページ
Front Matter リファレンス →