Using Canary with local search index

If you're working on a small side project or documentation, a local search index like Pagefind may suffice. You can run keyword-based searches locally and still benefit from our composable components.

TIP

Wanna try it out? We made a demo for you!

Any documentation & Any search index

Our UI components are decoupled from the actual operation layer.

We currently support:

• Any Pagefind based search using canary-provider-pagefind
• VitePress with Minisearch using canary-provider-vitepress-minisearch

Migrate to cloud provider

If you need more features, you can easily migrate.

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