Dismissible Banners
Users can dismiss announcements with a close button. Dismissed state persists in localStorage across sessions.
Welcome to starlight-announcement plugin! Get Started
Starlight Announcement
Enhanced announcement banners with dismissibility, variants, scheduling, and page targeting for your Starlight docs.
Features
Section titled “Features”Multiple Variants
Choose from note, tip, caution, or danger variants matching Starlight’s aside styles.
Date Scheduling
Show announcements only during specific date ranges with startDate and endDate options.
Page Targeting
Use glob patterns with showOn and hideOn to control which pages display each announcement.
Display Modes
Stack multiple announcements, show only the first match, or rotate through them with smooth transitions.
Internationalization
Built-in translations for multiple languages plus support for localized announcement content.
Rich Content
Use HTML in announcement content for bold text, links, and other formatting.
CSS Customization
Fully customizable via CSS variables and selectors. Create custom color themes with ease.
Next Steps
Section titled “Next Steps”Install the plugin
Check the getting started guide for installation instructions.
Why this plugin?
See how it compares to Starlight’s built-in Banner component.
Configure announcements
Learn how to configure announcements with variants, scheduling, and targeting.
Live demos
See the plugin in action with interactive demos showcasing all features.