From de25ba52651d2210d98d9e8413c95ea8aeb70372 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 20 Mar 2026 14:14:45 +0100 Subject: [PATCH] Document how to build the search index locally Signed-off-by: Johannes Marbach --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 0678713b..d2bf3152 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,18 @@ We use a highly customized [Docsy](https://www.docsy.dev/) theme for our generat Awesome. If you're looking at making design-related changes to the spec site, please coordinate with us in [#matrix-docs:matrix.org](https://matrix.to/#/#matrix-docs:matrix.org) before opening a PR. +## Page search + +The spec uses [Pagefind](https://pagefind.app/) to provide a page search widget. To test this locally, you'll need to generate the +search index _after_ building the static site. + +``` +hugo build && npx -y pagefind --site public && hugo serve +``` + +Note that while `hugo serve` supports hot reloading, changes made to the site content won't reflect in the search index without +rebuilding it. + ## Building the specification If for some reason you're not a CI/CD system and want to render a static version of the spec for yourself, follow the above