Loading

API reference

pagefind-net exposes a small, focused API surface across two packages.

The indexer package. All types are in the Pagefind.Net namespace.

Type Description
PagefindIndex Accumulates documents and writes the index to disk.
PagefindRecord A single searchable document.
WeightedSegment A text segment with a search weight.
PagefindAnchor A heading anchor for sub-page deep links.
PagefindIndexOptions Configuration for language and tokenisation.

The runtime delivery package. All types are in the Pagefind.Net.Frontend namespace.

Type Description
PagefindFrontend Static class for extracting the JS/WASM runtime.