Enable to opt out of pagefind

[justin5267]

What version of starlight are you using?

0.5.2

What is your idea?

Add support for disabling pagefind componet globally

Why is this feature necessary?

when using third-party search services, pagefind still generates indexes during project deployment, which can be time-consuming.

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this issue.

[delucis]

Thanks for the suggestion!

Search customisation is something we want to add, for example for people who would like to add an alternative service instead of the default Pagefind solution, so this is probably something we should tackle together with that.

[justin5267]

Thanks for your reply and could you help me with how to disable Pagefind from generating indexes? I've looked around but don't know how to turn it off.

[stereobooster]

it should be easy to add config here

starlight/packages/starlight/index.ts

Lines 79 to 90 in 8c0b267

	'astro:build:done': ({ dir }) => {
	const targetDir = fileURLToPath(dir);
	const cwd = dirname(fileURLToPath(import.meta.url));
	const relativeDir = relative(cwd, targetDir);
	return new Promise<void>((resolve) => {
	spawn('npx', ['-y', 'pagefind', '--site', relativeDir], {
	stdio: 'inherit',
	shell: true,
	cwd,
	}).on('close', () => resolve());
	});
	},

[justin5267]

Many thanks!

[delucis]

It’s not currently possible. We’d need to add a configuration option for this.

[delucis]

This will be possible in our next release — v0.14 🎉

You will be able to set a new pagefind option in the Starlight integration config:

starlight({
  pagefind: false,
})

Docs: https://starlight.astro.build/reference/configuration/#pagefind