Skip to main content

Configuration

OptionTypeDefaultDescription
statuspageUrlstringrequiredYour StatuspageStatuspage Atlassian's hosted status-page product with a public JSON API for incidents and component statuses..io base URL (e.g. https://acme.statuspage.io).
enabledbooleantrueDisable the plugin without removing it from config.
positionstring'bottom-left''bottom-left' | 'bottom-right' | 'top-left' | 'top-right'
linkLabelstring'View status'Text for the link to your status page.

Examples

Custom position + label

[
'docusaurus-plugin-statuspage',
{
statuspageUrl: 'https://acme.statuspage.io',
position: 'top-right',
linkLabel: 'Check service status →',
},
];

Temporarily disabled

[
'docusaurus-plugin-statuspage',
{
statuspageUrl: 'https://acme.statuspage.io',
enabled: process.env.NODE_ENV === 'production',
},
];

Styling

The banner uses Docusaurus CSS variables so it inherits your theme automatically. For custom styling, target the banner via standard DOM selectors in your src/css/custom.css — the plugin's markup uses semantic ARIA roles (role="status") which are the most stable selectors.