🐤 Canary

Appearance

Docusaurus ​

WARNING

Canary Cloud is in active development. Not ready for production use yet.

Installation ​

TIP

If you were using @getcanary/docusaurus-theme-search-pagefind before, please remove it.

bash
npm install @getcanary/web

Configuration ​

bash
npm run swizzle @docusaurus/theme-classic SearchBar -- --eject

After ejecting, you can edit generated files in src/theme/SearchBar.

html
<canary-root framework="docusaurus">
  <canary-provider-pagefind>
    <canary-provider-cloud api-key="KEY" api-base="https://cloud.getcanary.dev">
      <!-- Rest of the code -->
    </canary-provider-cloud>
  </canary-provider-pagefind>
</canary-root>

Take a look at our implementation of docusaurus-theme-search-pagefind here.