Registry / web-framework / vite-plugin-pagefind

vite-plugin-pagefind

library1.1.1jsnpmunverified

A Vite plugin that integrates Pagefind search indexing into Vite projects. v1.1.1 (stable) supports Vite >=4.0.0 and enables Pagefind to work during development with configurable strategies (lazy/eager). Unlike manual Pagefind setup, this plugin provides seamless Vite integration, TypeScript types, and inline configuration (removed JSON config support in v1.0.0). Release cadence: ~2-3 months. Key differentiator: fully inlined config and dev-mode indexing.

web-framework

npm install vite-plugin-pagefind

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-PAGEFI

vite-plugin-pagefind

web-frameworkjavascriptv1.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

pagefind

✓ import { pagefind } from 'vite-plugin-pagefind'

✗ import pagefind from 'vite-plugin-pagefind'

Named export, not default. Since v1.0.0 only inline config is supported.

Pagefind

✓ import type { Pagefind } from 'vite-plugin-pagefind/types'

✗ import { Pagefind } from 'vite-plugin-pagefind'

Type-only export from '/types' subpath. Only available in TypeScript.

default

✓ const plugin = require('vite-plugin-pagefind'); plugin.pagefind({...})

✗ import pagefind from 'vite-plugin-pagefind'

CommonJS requires destructuring the named export.

Configures Vite with the Pagefind plugin using inline options and sets up the build script to run Pagefind after Vite build.

// pnpm add -D pagefind vite-plugin-pagefind // vite.config.ts import { defineConfig } from 'vite'; import { pagefind } from 'vite-plugin-pagefind'; export default defineConfig({ plugins: [ pagefind({ outputDirectory: 'dist', assetsDirectory: 'public', bundleDirectory: 'pagefind', buildScript: 'build', developStrategy: 'lazy', }), ], }); // package.json { "scripts": { "build": "vite build && pagefind --site 'dist'" } }

Debug

Known issues

breakingv1.0.0 removed support for pagefind.json config. All options must be passed inline to the plugin.

fix

Move any pagefind.json settings into the plugin options object in vite.config.ts.

affects: >=1.0.0

gotchaThe 'developStrategy' option defaults to 'lazy', which only indexes if the bundle directory is missing. Use 'eager' if you need indexing on every dev start.

fix

Set developStrategy: 'eager' in plugin options.

affects: >=0.3.0

gotchaThe 'pagefind' package is required as a dependency; it is not automatically installed.

fix

Install pagefind separately: pnpm add -D pagefind.

affects: >=0.0.1

gotchaImporting 'pagefind' as default will result in undefined because the export is named.

fix

Use named import: import { pagefind } from 'vite-plugin-pagefind'.

affects: >=1.0.0

deprecatedv0.x used pagefind.json for configuration; that file is ignored in v1.0.0+.

fix

Remove pagefind.json and pass options inline.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'vite-plugin-pagefind'

Package not installed or import path incorrect.

fix

Ensure plugin is installed: pnpm add -D vite-plugin-pagefind, and use correct import path: 'vite-plugin-pagefind'.

TypeError: pagefind is not a function

Default import instead of named import.

fix

Change to import { pagefind } from 'vite-plugin-pagefind'.

Error: build script not found

The buildScript option refers to a script that does not exist in package.json.

fix

Define the script in package.json scripts, or set buildScript to 'build' (default) and ensure it exists.

The 'pagefind' package is not installed

Missing runtime dependency.

fix

Install pagefind: pnpm add -D pagefind.

Upgrade

Version history

1.1.1latest on npm

Audit

Dependencies

pagefindoptionalRuntime peer dependency — Pagefind binary is used for indexing during build and dev

viterequiredPeer dependency — plugin requires Vite >=4.0.0

Agent activity

5 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Hugos68/vite-plugin-pagefind ↗

packagehttps://www.npmjs.com/package/vite-plugin-pagefind ↗