Starlight

TIP

If you're looking for Canary Cloud, please refer to this page instead.

Starlight is a template built on top of Astro for building documentation.

Since Starlight already have built-in integration with Pagefind, so you can just leverage the existing index with canary-provider-pagefind.

Three steps to integrate

Step 1: Install @getcanary/web

npm install @getcanary/web

Step 2: Create search component

YOUR_COMPONENT.astro

---
const options = {
  path: `${import.meta.env.BASE_URL}pagefind/pagefind.js`,
  // https://pagefind.app/docs/ranking
  // Optional, default values are:
  pagefind: {
    ranking: {
      pageLength: 0.75,
      termFrequency: 1.0,
      termSimilarity: 1.0,
      termSaturation: 1.4,
    },
  },
};
---

<script>
  import "@getcanary/web/components/canary-root.js";
  import "@getcanary/web/components/canary-provider-pagefind.js";
  import "@getcanary/web/components/canary-trigger-searchbar.js";
  import "@getcanary/web/components/canary-modal.js";
  import "@getcanary/web/components/canary-content.js";
  import "@getcanary/web/components/canary-input.js";
  import "@getcanary/web/components/canary-search.js";
  import "@getcanary/web/components/canary-search-results.js";
</script>

<canary-root framework="starlight">
  <canary-provider-pagefind options={JSON.stringify(options)}>
    <canary-modal>
      <canary-trigger-searchbar slot="trigger"></canary-trigger-searchbar>
      <canary-content slot="content">
        <canary-input slot="input"></canary-input>
        <canary-search slot="mode">
          <canary-search-results slot="body"></canary-search-results>
        </canary-search>
      </canary-content>
    </canary-modal>
  </canary-provider-pagefind>
</canary-root>

<!-- https://getcanary.dev/docs/common/customization/styling#css-variables -->
<style>
  canary-root {
    --canary-color-primary-c: 0.1;
    --canary-color-primary-h: 170;
  }
</style>

Specifying framework="starlight" is required to detect light/dark mode changes.

Step 3: Override default search component

astro.config.mjs

// https://starlight.astro.build/guides/overriding-components/#how-to-override
export default defineConfig({
  integrations: [
    starlight({
      components: { Search: "<PATH_TO_YOUR_COMPONENT>.astro" }, 
    }),
  ],
});

WARNING

You should run astro build && astro preview to try the search locally.

It won't work with astro dev.