pagefind

Pagefind Static Search

Pagefind is a fully static search library that aims to perform well on large sites, while using as little of your users’ bandwidth as possible, and without hosting any infrastructure.

The full documentation on using Pagefind can be found at https://pagefind.app/.

This packages houses a wrapper for running the precompiled Pagefind binary, and also serves as a NodeJS indexing library that can be integrated into existing tools.

Running Pagefind through NPX

This is the recommended way of running Pagefind on a static site.

npx pagefind --site "public"

For more details on using the Pagefind binary, see Installing and running Pagefind, and the rest of the Pagefind documentation.

Using Pagefind as a Node library

This package also provides an interface to the Pagefind binary directly as a package you can import.

import * as pagefind from "pagefind";

// Create a Pagefind search index to work with
const { index } = await pagefind.createIndex();

// Index all HTML files in a directory
await index.addDirectory({
    path: "public"
});

// Add extra content
await index.addCustomRecord({
    url: "/resume.pdf",
    content: "Aenean lacinia bibendum nulla sed consectetur",
    language: "en",
});

// Get the index files in-memory
const { files } = await index.getFiles();

// Or, write the index to disk
await index.writeFiles({
    outputPath: "public/pagefind"
});

For more details on using Pagefind as a library, see Indexing content using the NodeJS API.

Changelog

v1.3.0 (December 18, 2024)

Core Features & Improvements

• Added --quiet and --silent flags when running the Pagefind CLI, which reduce the logging output to only warnings or only errors respectively.
• Stablized the Pagefind Rust library.
  • Thanks to @cdxker for leading this in #751 ❤️
  • This library interface has feature parity with the Node and Python indexing APIs, and is a great solution for integrating Pagefind indexing into any Rust-based tooling.

Default UI Features & Improvements

• Added a data-pagefind-ui-meta attribute to the metadata tags on search results in the Default UI, allowing them to be targeted with CSS.
  • For example, a tag on a result containing Date: April 19, 2024 will now have data-pagefind-ui-meta="date".

Fixes & Tweaks

• Fixed an issue where inline metadata would incorrectly render with html-escaped characters.
  • Specifically, tagging metadata inline with data-pagefind-meta="phrase:this < that would index the literal < rather than a < character.
  • This bug didn't occur when using data-pagefind-meta to capture the content of an element.
• Fixed an issue where matches in compound words could (sometimes) be ranked lower than intended.
  • Specifically, for example, matching just the Cannon in CloudCannon may have ranked the word incorrectly.
• Fixed an issue where fragment hashes would change between every Pagefind build.
  • Now, if an HTML page has not changed between two Pagefind indexes, the fragment filename will not change.
  • This saves you from having to re-upload all fragment files after every Pagefind build.