Add custom announcement banners to your Starlight docs with scheduling, theming, and i18n support.
- Display announcement banners at the top of your documentation,
- Schedule announcements with start and end dates,
- Multiple display modes: static, closable, and rotating,
- Fully customizable theming with built-in and custom styles,
- Per-announcement icon override via SVG path, or hide the icon entirely,
- Internationalization (i18n) support for localized content,
- Accessible components with proper ARIA attributes,
- Works seamlessly with Starlight's existing configuration.
Install the plugin using your preferred package manager:
npm install starlight-announcement// astro.config.mjs
import starlight from '@astrojs/starlight';
import starlightAnnouncement from 'starlight-announcement';
export default defineConfig({
integrations: [
starlight({
plugins: [
starlightAnnouncement({
announcements: [
{
content: 'Welcome to our documentation!',
},
],
}),
],
}),
],
});For comprehensive documentation, installation guides, configuration options, and examples, visit the plugin documentation.
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
Licensed under the MIT License, Copyright © frostybee.
See LICENSE for more information.