Replace the search index with Pagefind

astro.config.mjs

@@ -3,11 +3,13 @@ import { satteri } from '@astrojs/markdown-satteri';
 import mdx from '@astrojs/mdx';
 import { attributeMarkdown, wrapTables } from '/src/themes/octopus/utilities/custom-markdown.mjs';
 import llmMdEmitter from './src/integrations/llm-md-emitter.ts';
+import pagefindIndex from './src/integrations/pagefind-index.ts';
 import pruneDist from './src/integrations/prune-dist.ts';
 import satteriHeadingId from './src/plugins/satteri-heading-id.js';
 import satteriApiExamples, { apiExampleDirective } from './src/plugins/satteri-api-examples.js';
 import { endpointDirective } from './src/plugins/satteri-endpoint.js';
 import satteriWbr from './src/plugins/satteri-wbr.js';
+import pagefindImageAttrs from './src/plugins/pagefind-image-attrs.js';
 import shikiCodeBlock from './src/plugins/shiki-code-block.js';
 
 // https://astro.build/config
@@ -22,6 +24,9 @@ export default defineConfig({
     integrations: [
         mdx(),
         llmMdEmitter(),
+        // After the page emitters, and before the prune that would delete its
+        // output
+        pagefindIndex(),
         // Must run last: strips build output that can't be served under /docs/
         pruneDist()
     ],
@@ -63,6 +68,7 @@ export default defineConfig({
             ],
             hastPlugins: [
                 satteriWbr,
+                pagefindImageAttrs,
                 satteriApiExamples
             ],
         }),

dictionary-octopus.txt

@@ -405,6 +405,7 @@ Ozar
 PAAS
 packageid
 packageversion
+pagefind
 passout
 PathtoPublish
 pemstore

package.json

@@ -33,9 +33,8 @@
         "astro-accelerator-utils": "^0.3.84",
         "glob": "^13.0.6",
         "gray-matter": "^4.0.3",
-        "html-to-text": "^10.0.0",
-        "keyword-extractor": "^0.0.28",
         "optional": "^0.1.4",
+        "pagefind": "^1.5.2",
         "satteri": "^0.9.5",
         "sharp": "^0.34.5"
     },

src/components/ArticleHeader.astro

@@ -12,8 +12,11 @@ type Props = {
   lang: string;
   subtitle?: string | null;
   title: string;
+  /** Passed to `data-pagefind-weight`. Omitted leaves Pagefind's own heading
+   *  weighting alone. */
+  searchWeight?: number;
 };
-const { lang, subtitle, title } = Astro.props satisfies Props;
+const { lang, subtitle, title, searchWeight } = Astro.props satisfies Props;
 
 // Language
 const _ = Lang(lang);
@@ -22,7 +25,7 @@ const _ = Lang(lang);
 stats.stop();
 ---
 
-<header class="header">
+<header class="header" data-pagefind-weight={searchWeight}>
   <h1 class="header__title">{title}</h1>
   {subtitle && <p class="header__subtitle">{subtitle}</p>}
 </header>