Docusaurus plugins
This site documents — and dogfoods — a family of Docusaurus v3 plugins. Every plugin you read about here is also installed and configured in the site you're reading it on, so each page is itself an example of the plugin in action.
The plugins
| Plugin | What it does |
|---|---|
| Banner | Dismissable announcement banner at the top of every page, with localStoragelocalStorage A browser API for persisting small amounts of string data per-origin across sessions. persistence. |
| Cookie consent | GDPRGDPR EU data-protection regulation that requires explicit consent before setting non-essential cookies or tracking users.-style consent modal/toast with Google Consent Mode v2 integration and a React hook for gated scripts. |
| Glossary | Auto-generated glossary page, a GlossaryTerm component, and a remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. plugin that auto-links terms in markdown. |
| Marginalia | Editorial sidenotes: inline anchors paired with cards that pack top-down in the right margin and highlight on scroll. |
| New post toast | Toast notifications for new blog posts since the user's last visit — purely client-side. |
| omg | Build-time OMG → OpenAPI 3.1 compiler that reads markdown-defined APIs and writes a spec to static/. |
| Starter | A lean template for building your own Docusaurus plugin: lifecycle hookslifecycle hook One of Docusaurus's plugin API methods (loadContent, contentLoaded, postBuild, …) invoked during the build., client modulesclient module A JS/TS file registered via a plugin's getClientModules() that runs on every client-side navigation in the browser., remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX., theme, and tests. |
| StatuspageStatuspage Atlassian's hosted status-page product with a public JSON API for incidents and component statuses. | Discreet banner that surfaces ongoing incidents from a public StatuspageStatuspage Atlassian's hosted status-page product with a public JSON API for incidents and component statuses..io instance. |
How the docs are organised
Each plugin has:
- Overview — what it is, why you'd use it
- Getting started — minimal install + config
- Configuration — the full option table
- Advanced — nested pages for deeper features (categories, hooks, Google Consent Mode, remarkremark A markdown processor. Remark plugins transform the markdown AST before it becomes HTML/JSX. integration, etc.)
Every plugin repo also ships a runnable examples/ directory — those are linked from each plugin's overview page.
Compatibility
All plugins target Docusaurus ^3.0.0 and React ^18. Node 18+ required.