バナー

サイト全体で重要なお知らせや通知を表示するバナーを追加する

バナーを使うと、ドキュメントサイト全体に重要なお知らせ、更新情報、通知を表示できます。バナーは各ページの上部に表示され、Markdownの書式に対応し、ユーザーが閉じられるように設定できます。

バナーを追加するには、docs.json の banner プロパティを使用します:

Product announcements

"banner": {
  "content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",
  "dismissible": true 
}

プロパティ

content · string · required

バナーのメッセージ。プレーンテキストとMarkdownの書式に対応します。

dismissible · boolean

ユーザーがバナーを閉じられるかどうか。true の場合、ユーザーはバナーを閉じることができ、同一セッション内では再表示されません。デフォルトは false です。