chore(deps): update dependency pagefind to v1.5.2 #139
No reviewers
Labels
No labels
bug
dependencies
documentation
duplicate
enhancement
good first issue
help wanted
invalid
javascript
no-pr-activity
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
florian/florianbeisel.github.io!139
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "renovate/pagefind-1.x-lockfile"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
1.4.0→1.5.2Release Notes
Pagefind/pagefind (pagefind)
v1.5.2Compare Source
v1.5.0was meant to 2x indexing performance, which it does on macOS and Windows. On Linux, with the published musl build, it actually halves the indexing performance. This release subs in jemalloc on Linux musl builds to fix the musl allocator thrashing, and performance now achieves the 2xv1.4.0claim.v1.5.0Compare Source
Hey! This is a big one. Pagefind 1.5.0 has been fermenting for a while, and addresses a lot of long-standing issues and feature requests. This release brings an entirely new search UI built on web components, major improvements to search relevance and ranking, diacritics support, automatic CJK segmentation, Web Worker search, notably smaller indexes, and a much faster indexing binary. Enormous thanks to everyone who contributed features and fixes, as well as to everyone who tested the beta releases and provided feedback ❤️ - @bglw
If you only read this far, I should mention up front: The existing Default UI and Modular UI remain available and supported for now, so you can upgrade your sites to Pagefind v1.5.0 without migrating to the Component UI.
Pagefind Component UI
Pagefind ships a brand new UI system built entirely on web components. The Component UI gives you searchboxes, modals, result lists, and filter controls as composable
<pagefind-*>elements that you can mix, match, and style with CSS variables.The Component UI is available as vendored files in your
/pagefind/output directory, or as an npm package to install and import.The best way to get a feel for the new components is on the 📘 Pagefind Component UI page of the docs, where interactive examples of various components are shown.
Extra goodies with the Component UI:
Search Relevance, and Searching Metadata
Pagefind now searches metadata by default! Importantly, this means it now searches the title metadata. Matches in titles are now taken into account, and search results are very hard to shake from prime positions if all (or much) of the title matches the search query.
You can configure the weight of any metadata field. See 📘 Configuring Metadata Weights to change the title boost or apply custom weights to your own metadata fields.
Beyond metadata searching, a bunch of weird and wonderful ranking bugs were resolved:
Diacritics Support
We finally properly support matching across diacritics. You can now find your cafés without remembering how to type é.
By default, exact diacritic matches are preferred. So if you're searching "cafe", pages with "cafe" will rank higher than pages with "café". Getting this relevance right by default was the final piece of the puzzle for shipping this, which is why it took a while to land. See 📘 Configuring Diacritic Similarity to adjust how this plays out on your site.
If you need strict matching, set
exactDiacritics: trueto disable normalization entirely — "cafe" will only match "cafe", and "café" will only match "café". 📘 Exact DiacriticsMultilingual Improvements
Thanks browsers! Pagefind now taps into Intl.Segmenter to chop search queries in CJK (Chinese, Japanese, Korean) non-whitespace-delimited languages. This was already done during indexing by Pagefind, but users searching still had to delimit their queries. Now searching "这是一段简单的测试文本" searches for the words "这", "是", "一段", "简单", "的", "测试", and "文本", which is also how that sentence was indexed.
We also updated the underlying stemming library (thanks @uded !) which brings stemming support for Polish and Estonian (and Esperanto, if anyone is out there indexing some
lang="eo"pages). The Snowball upgrade also improves stemming quality across many already-supported languages.Indexing Performance
The indexing binary (the one you install through npx or your wrapper of choice) is now both smaller (so, faster to download) and faster to run, by quite a lot on both fronts. On some sites, indexing is more than twice as fast. Thanks to @zmre for much of this!
Search Performance
Pagefind's search now runs in a Web Worker automatically. This doesn't make the search faster, per se, but it dramatically improves perceived performance on large websites by keeping the main thread responsive. If Web Workers are unavailable, it falls back to the main thread automatically.
Plus: Some low-hanging fruit was picked off, and Pagefind's index chunks are now ~45% smaller thanks to delta-encoding page numbers and word locations.
New Search Options
metaCacheTag— Allows you to configure the cache-busting tag on the metadata file (which is fetched fresh on every page load). For offline/PWA scenarios where assets need to be served with service workers, this can now be overridden.plain_excerpt— Search results and sub-results now include aplain_excerptfield containing the excerpt text without highlight mark tags, for those who want to handle highlighting themselves (or don't want it at all).matchedMetaFields— Search results now include amatchedMetaFieldsfield listing which metadata fields matched the search query.includeCharactersis now available in the Node and Python wrapper APIs.UI Translations
Other bits and bobs
./image.png) breaking when displayed in search results. (PR #1087)arm64. (PR #950 — thanks @lioman !)pagefindPyPI package. (PR #991)aarch64-pc-windows-msvc) as a supported platform. (PR #1079)actix-weband related serving dependencies behind aservefeature flag (PR #1023)Looking Forward
The Component UI is the new recommended way to add search to your site, and future UI work will focus there. The Default UI and Modular UI are sticking around for now, but the Component UI is where new features will land first.
Thanks again to everyone who contributed to this release!
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate.
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.