Why use Canary?

Modular and open-source

We're fully open-source, and encourage anyone to contribute to our UI components. Also, we put a lot of effort into making the core parts of Canary as modular as possible.

Tiny components that works anywhere

Canary use Web components, so browsers know how to render it.

_source

Seamless integrations

We currently support Docusaurus, VitePress, and Starlight. Since Canary uses Web Components, it can easily be integrated with any other framework.

Not only that, but we support both Local and Cloud options. This means you can quickly add search functionality to your docs, without setting up an account or paying anything.

If you decide to use Canary Cloud for more features, you can easily migrate.

<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>