diff --git a/fern/products/docs/pages/customization/frontmatter.mdx b/fern/products/docs/pages/customization/frontmatter.mdx index 0e0c1535b..535e12ec2 100644 --- a/fern/products/docs/pages/customization/frontmatter.mdx +++ b/fern/products/docs/pages/customization/frontmatter.mdx @@ -213,6 +213,84 @@ hide-feedback: true Leave feedback feature +## Banner + + Displays a banner at the top of the page content. Can be set to `true` for a default warning banner, a string for a warning banner with custom message, or an object for full customization with different intents and colors. + + +### Simple usage + + +```mdx +--- +title: New Plant Species Guide +banner: true +--- +``` + + + +```mdx +--- +title: Experimental Plant Care API +banner: This plant care API is experimental and may change without notice. +--- +``` + + +### Advanced usage with intents + + +```mdx +--- +title: Plant Database Migration +banner: + message: We're migrating to a new plant database. Some features may be temporarily unavailable. + intent: info +--- +``` + + + +```mdx +--- +title: New Plant Identification Feature +banner: + message: Our new AI-powered plant identification feature is now available! + intent: success +--- +``` + + +Available intents: `info`, `warning`, `success`, `error`, `note`, `launch`, `tip`, `check` + +### Custom colors + + +```mdx +--- +title: Seasonal Plant Guide +banner: + message: Spring planting season has begun! Check out our seasonal recommendations. + intent: tip + color: + background: "#e8f5e9" + text: "#1b5e20" + border: "#4caf50" +--- +``` + + + +Custom colors may not adapt well to dark mode. Use with caution and test in both light and dark themes. + + +### Deprecated: beta property + + + **Deprecated.** Use `banner` instead. Displays a yellow warning banner at the top of the page to indicate that the content is in beta or still being worked on. + + ## Page logo Override the site-wide logo for a page. Specify different logos for light and dark modes using absolute URLs.