Skip to content

feat(search): replace lunr with Pagefind and a grouped-results search modal #2093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
haranrk wants to merge 11 commits into from
Closed

feat(search): replace lunr with Pagefind and a grouped-results search modal #2093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
304a6bb
build: add pagefind[bin] for static search indexing
haranrk Aug 7, 2026
ba73d00
feat(search): mark indexable page content for Pagefind
haranrk Aug 7, 2026
0e8f80b
feat(search): build a Pagefind index after each site build
haranrk Aug 7, 2026
2bbb315
test(search): verify Pagefind index scope and tokenization
haranrk Aug 7, 2026
aeb1969
feat(search): add search trigger and modal markup
haranrk Aug 7, 2026
a993020
feat(search): query Pagefind and render grouped results
haranrk Aug 7, 2026
6086592
feat(search): style the search modal with Material tokens
haranrk Aug 7, 2026
561a193
feat(search): remove the lunr search plugin
haranrk Aug 7, 2026
de9cad1
ci: verify the search index on every docs build
haranrk Aug 7, 2026
92d05a5
feat(search): rebind Material's /, s and f search shortcuts
haranrk Aug 7, 2026
602698a
feat(search): show the Cmd glyph on Apple platforms
haranrk Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/build-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ jobs:
mkdocs-material-
- run: pip install -r requirements.txt
- run: mkdocs build --strict
- run: python scripts/verify_search_index.py site
2 changes: 2 additions & 0 deletions .github/workflows/publish-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,6 @@ jobs:
restore-keys: |
mkdocs-material-
- run: pip install -r requirements.txt
- run: mkdocs build --strict
- run: python scripts/verify_search_index.py site
- run: mkdocs gh-deploy --force
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,10 @@ cython_debug/
# mkdocs documentation
docs/site

# Local design/plan scratch space. Never committed; see the LOCAL_ONLY_PREFIX
# exemption in scripts/verify_search_index.py.
docs/superpowers/

# Utilities for local development
.gemini/
.scripts/
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ when using compatible AI coding tools in this repo.
This command starts a local docs server, typically at
`http://127.0.0.1:8000/`.

Set `PAGEFIND_SKIP=1` to skip building the search index on each rebuild
while authoring; site search will not work in that build, and because
skipping logs a warning, `mkdocs build --strict` fails while it is set.

## Create Your Contribution

| Type | Description |
Expand Down
Loading
Loading