Skip to content

非公式 / UnofficialCloudflare, Inc. 非提携。アカウント情報は入力しないでください。Not affiliated with Cloudflare, Inc. Do not enter Cloudflare credentials here.Official docsこのサイトについてプライバシー

注記 / ヒント / 警告

最終更新 Markdown で表示Agent セットアップ

定義

本文に収まらない補足や、機能を壊したりセキュリティに影響したりする挙動を伝える、色付きの情報ボックス(aside)です。テキスト、画像、リスト、コードブロックを含められます。

使用するコンテンツタイプ

How to、Configuration、FAQ、Concept、Reference、Tutorial

構成

Type: note または warning(背景色を決めます)

Aside の本文

(任意)タイトル / ヘッダー

テンプレート

注記の書式は 注記とその他の表記タイプ を参照してください。

表示例

注記 / 警告を使うタイミング

本文に組み込めない有用な追加情報を読者に伝えるときは、注記を使います。

ユーザーのネットワークセキュリティに影響したり、機能を壊したりする挙動を伝えるときは、警告を使います。

推奨事項

  • Aside に多くの内容を入れないでください。 通常の本文の流れが途切れます。目安は、段落 3 つまで、または箇条書き 3 項目までです。それ以上必要な場合は、「重要な注意」などのドキュメントセクションを検討してください。
  • Aside は控えめに使います。 各セクションで、同じ種類の aside は 1 つまでにしてください。例外は、見出し直後に置く可用性の免責のみです。
  • 手順のステップ内の aside にはヘッダーを付けないでください。 場所を取りすぎます。背景色だけで、通常の本文と区別できます。
  • 機能の利用制限を示すときは note aside を使います(例: 「Enterprise プランのお客様のみ利用できます。」)。ページ先頭に、ヘッダーなしで置きます。

役に立ちましたか?