Skip to main content

Getting started

Install​

npm install docusaurus-plugin-banner

Minimum config​

Add the plugin to your docusaurus.config.ts (or .js):

// docusaurus.config.ts
export default {
  plugins: [
    [
      'docusaurus-plugin-banner',
      {
        content: '🎉 Welcome to our documentation!',
      },
    ],
  ],
};

That's it. The banner appears at the very top of the site and can be dismissed — its state is stored in localStorage under docusaurus-banner-dismissed by default.

Next​