Releases: CloudCannon/pagefind
Releases · CloudCannon/pagefind
v0.9.2
- Pagefind can now automatically read gzipped HTML files as its source
- Pagefind's automatic metadata now falls back to the
title
of a page if there is noh1
element - Fixed a couple of inconsistent url formatting issues on Windows
v0.9.1
- Fix Windows release assets once more
v0.9.0
Important Changes
- Removed
<header>
from the list of elements that Pagefind automatically ignores- If this element contains content you do not want to be indexed, you will now need to add
data-pagefind-ignore
- If this element contains content you do not want to be indexed, you will now need to add
Features & Improvements
- Added sorting functionality to Pagefind, see the Sorting documentation and the JS API Sorting usage
- Added the functionality to filter an index without searching, by passing
null
as the search query - Added support for custom Pagefind UI strings, see Using custom Pagefind UI strings
- Added a default debounce to the user input for Pagefind UI, and a corresponding
debounceTimeoutMs
option, see Debounce user input- Many thanks to @dprothero for the contribution! 💝
- Added a hook to process results before showing them in Pagefind UI, see the processResult documentation
Fixes & Tweaks
- Fixed running Pagefind on Windows via the npx wrapper
- Pagefind now throws an error if a completely empty index is produced for whatever reason
- Fixed a bug where having exactly one known and one unknown language would drop the known language pages
- Fixed issue where
two<br/>words
would be indexed astwowords
rather than the correcttwo words
- Added
<style>
to the list of elements that Pagefind automatically ignores - Fixed the Pagefind UI
showEmptyFilters
option to work as expected - Fixed issue where adding a filter to a search with zero results would return all results for the filter
- Fixed uncommon bug around chunk boundaries
- For example: If your first search index chunk started with the word
hello
and you searched forh
, Pagefind would previously not load thehello
chunk and would instead return zero results.
- For example: If your first search index chunk started with the word
v0.8.1
- Pagefind now gracefully skips pages that fail HTML parsing, and provides more context when these errors are hit.
v0.8.0 — Multisite
Important Changes
- For those using the JS API directly, the
pagefind.options
function is now async. This will not break current usage, but using newer options may requireawait pagefind.options({ ... })
for them to be applied
Features & Improvements
- Added Multisite search support, allowing you to search multiple indexes from one Pagefind instance. See the new Multisite documentation for more information
- Added a preload function to the JS search API, allowing you to warm Pagefind up before a search, or while the user is typing. See the Preload documentation for more information
- Added a
timings
object to the JS search API response
Fixes & Tweaks
- Passing a non-existent filter to the search function would previously be silently ignored. This will now return zero results
- Setting your baseURL to an external domain such as
https://example.com
would previously be prepended with a/
. This is now handled correctly and will link off-site - Pagefind would previously index search entities such as
"
without unescaping them. This is now fixed and these characters will be skipped - Searching for only punctuation would previously return all pages currently loaded into the Pagefind index. This will now return zero results
- Fixed a regression causing searches for hyphenated-phrases to return zero results
- Fixed Pagefind UI failing to match complex language codes such as
zh-hans-tw
to less complex translation files such aszh-tw
v0.7.1 — Multilingual Followup
- Added French translations for Pagefind UI — thanks @nfriedli!
- Fixed standard & extended release archives attached to GitHub releases to be correctly assigned
v0.7.0 — Multilingual Support
Features & Improvements
- Multilingual support
- Pagefind now works out of the box for multilingual sites
- Pagefind UI is now translated into
af
,de
,en
,ja
,no
,pt
,ru
, &zh
- See the multilingual documentation for more information on this feature release
- This release adds a
pagefind_extended
binary release, which is larger than thepagefind
release but includes support for indexing Chinese and Japanese languages- (It looks like the release pipeline is misconfigured and published the extended release for both, but in future releases this will be true)
pagefind_extended
is now the default when runningnpx pagefind
. The smallerpagefind
release is still available via the GitHub Release attachments
Fixes & Tweaks
- Improved Pagefind logging and added a
--verbose
flag with extra information - Added warnings when Pagefind encounters pages without outer
<html>
elements - Added a console warning when Pagefind detects that a cached
pagefind.js
file was loaded alongside a search index from a newer release
v0.6.1
- Oops — fixes the npx wrapper on Windows
v0.6.0
Features & Improvements
- Added prebuilt Windows binaries
- This adds Windows support for running Pagefind via
npx pagefind
- Windows binaries can also be downloaded via the GitHub Releases
- This adds Windows support for running Pagefind via
v0.5.3
Tēnā koutou katoa — Fixed an issue where Pagefind could not search for words containing some special characters.