Boost schema reference pages in Pagefind results

Author: FireGiantDocs

astro.config.mjs

@@ -45,6 +45,9 @@ export default defineConfig({
       components: {
         // Override the default `Head` component to add our page tracking.
         Head: './src/components/starlight/Head.astro',
+        // Boost schema reference pages in Pagefind results.
+        MarkdownContent: './src/components/starlight/MarkdownContent.astro',
+        PageTitle: './src/components/starlight/PageTitle.astro',
         // Override the default `SiteTitle` component to link to both firegiant.com and docs.firegiant.com.
         SiteTitle: './src/components/starlight/SiteTitle.astro',
       },

src/components/starlight/MarkdownContent.astro

@@ -0,0 +1,11 @@
+---
+import '@astrojs/starlight/style/markdown.css';
+import { PRIORITY_PAGEFIND_CONTENT_WEIGHT, isPrioritySearchSlug } from '../../utils/pagefind';
+
+const slug = Astro.locals.starlightRoute.entry.slug;
+const dataAttributes = isPrioritySearchSlug(slug)
+  ? { 'data-pagefind-weight': PRIORITY_PAGEFIND_CONTENT_WEIGHT }
+  : {};
+---
+
+<div class="sl-markdown-content" {...dataAttributes}><slot /></div>

src/components/starlight/PageTitle.astro

@@ -0,0 +1,23 @@
+---
+import { PRIORITY_PAGEFIND_TITLE_WEIGHT, isPrioritySearchSlug } from '../../utils/pagefind';
+
+const PAGE_TITLE_ID = '_top';
+const slug = Astro.locals.starlightRoute.entry.slug;
+const dataAttributes = isPrioritySearchSlug(slug)
+  ? { 'data-pagefind-weight': PRIORITY_PAGEFIND_TITLE_WEIGHT }
+  : {};
+---
+
+<h1 id={PAGE_TITLE_ID} {...dataAttributes}>{Astro.locals.starlightRoute.entry.data.title}</h1>
+
+<style>
+  @layer starlight.core {
+    h1 {
+      margin-top: 1rem;
+      font-size: var(--sl-text-h1);
+      line-height: var(--sl-line-height-headings);
+      font-weight: 600;
+      color: var(--sl-color-white);
+    }
+  }
+</style>

src/utils/pagefind.ts

@@ -0,0 +1,8 @@
+const PRIORITY_SEARCH_PREFIXES = ['wix/schema/', 'firegiant/schema/'] as const;
+
+export const PRIORITY_PAGEFIND_CONTENT_WEIGHT = '8';
+export const PRIORITY_PAGEFIND_TITLE_WEIGHT = '10';
+
+export function isPrioritySearchSlug(slug: string): boolean {
+  return PRIORITY_SEARCH_PREFIXES.some((prefix) => slug.startsWith(prefix));
+}