Skip to content

Replace Algolia search with built-in search#2007

Merged
cderv merged 1 commit intoquarto-dev:mainfrom
cderv:claude/replace-algolia-basic-search-CFDA6
May 1, 2026
Merged

Replace Algolia search with built-in search#2007
cderv merged 1 commit intoquarto-dev:mainfrom
cderv:claude/replace-algolia-basic-search-CFDA6

Conversation

@cderv
Copy link
Copy Markdown
Member

@cderv cderv commented May 1, 2026

Summary

  • Algolia hosting is no longer available, so the navbar overlay search is broken. Switch to Quarto's built-in client-side search (the documented default — docs/websites/website-search.qmd), which reads the same _site/search.json Quarto already emits during render.
  • Remove the algolia: blocks from _quarto.yml and _quarto-prerelease-docs.yml; the surviving show-item-context / type: overlay keys are honored by the built-in backend.
  • Delete the supporting Algolia tooling: post-render index augmenter, Ruby uploader, upload-index / test-algolia-upload workflows, algolia-config.json, and the orphan search-by-algolia.png logo. Trim the matching bullet/row in .github/workflows/README.md and _tools/README.md so the inventory stays accurate.

Test plan

  • Trigger the Netlify deploy preview (/deploy-preview comment, since this is a fork PR) and confirm the build succeeds with no post-render errors.
  • On the preview site: open the navbar search overlay; query "callout", "yaml", "shortcode"; confirm results render from the local index with breadcrumbs (show-item-context: true) and that clicking a result navigates and ?q= highlight still works.
  • After the auto-backport PR opens, repeat the same search check on the prerelease deploy preview.
  • After merge: the repo's ALGOLIA_API_KEY secret can be deleted from Settings → Secrets, and the Algolia upload workflow won't appear in the Actions tab anymore.

Algolia hosting is no longer available, so the navbar overlay search is
broken on quarto.org and prerelease.quarto.org. Drop the `algolia:`
configuration so the site falls back to Quarto's built-in client-side
search over the locally generated `search.json` index -- the documented
default behavior, no extra config needed.

Also remove the now-dead supporting tooling:
- _tools/algolia-add-custom-attribute.ts (post-render index augmenter)
- .github/workflows/upload-index.yml (nightly index upload)
- .github/workflows/test-algolia-upload.yml
- .github/workflows/upload-algolia.rb
- .github/workflows/algolia-config.json
- search-by-algolia.png (orphan asset)

Drop the matching bullet/row in .github/workflows/README.md and
_tools/README.md so the inventory stays accurate.

https://claude.ai/code/session_01GppXdbFEV144FzLi6mVLbG
@cderv
Copy link
Copy Markdown
Member Author

cderv commented May 1, 2026

/deploy-preview

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2007.quarto.org

@cderv cderv merged commit 14cc76d into quarto-dev:main May 1, 2026
4 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Successfully created backport PR for prerelease:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants