README.md

🐤 Canary

Search & Ask AI across your docs(webpage), GitHub issues, and discussions.

(OpenAPI, changelog, etc. are coming soon.)

Glob / tag filters, light / dark mode, multiple panels for Search / Ask AI, and more!

Search	Ask AI

code example:

<canary-root framework="vitepress">
  <canary-provider-cloud project-key="">
    <canary-modal>
      <canary-trigger-searchbar slot="trigger"></canary-trigger-searchbar>
      <canary-content slot="content">
        <canary-input slot="input" autofocus></canary-input>
        <canary-search slot="mode">
          <canary-search-results slot="body"></canary-search-results>
        </canary-search>
        <canary-ask slot="mode">
          <canary-ask-results slot="body"></canary-ask-results>
        </canary-ask>
      </canary-content>
    </canary-modal>
  </canary-provider-cloud>
</canary-root>

Get started

We have documentation available at getcanary.dev.