Plugins

Search Plugin

Full-text search with Pagefind

The search plugin enables full-text search powered by Pagefind. It indexes your documentation at build time and provides a fast, client-side search experience.

Installation

pnpm add @barodoc/plugin-search@latest

Configuration

{
  "plugins": [
    ["@barodoc/plugin-search", {
      "enabled": true,
      "pagefind": {
        "exclude": ["api/*"]
      }
    }]
  ]
}

Search is enabled by default. The search UI is built into the theme and accessible via the search bar in the header or the Ctrl+K / Cmd+K keyboard shortcut.

Options