Wire local search via @easyops-cn/docusaurus-search-local (#193 of Fallout)#4
Merged
Merged
Conversation
…llout)
Adds in-bundle, build-time search to docs.fallout.build. The index is
generated at build time and shipped with the static site — no external
service.
Pinned to 0.54.1 deliberately. The 0.55.x line added `open-ask-ai`
(an AI Q&A widget) as a hard peer dependency; we don't want that
feature or that runtime dependency on the docs site. 0.54.1 is the
last release before that change and supports Docusaurus 3 + React 19.
Config notes:
- hashed:true — content-hashed index filenames so CDN/Pages caching
invalidates correctly when content changes.
- indexBlog:false — Falloutdocs has no blog (blog:false in classic
preset); without this the plugin warns.
- docsDir:'fallout-source/docs' — markdown source lives in the
sibling Fallout repo, checked out into ./fallout-source/ at build
time (matches the existing docs preset's path:'./fallout-source/docs').
- highlightSearchTermsOnTargetPage:true and explicitSearchResultPath
— small UX wins on the search-results page and on landed pages.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes ChrisonSimtian/Fallout#193 — adds in-bundle search to https://docs.fallout.build/. The index is generated at build time and shipped with the static assets; no external service involved.
Why this plugin / why this version
Config choices
Verification
What this PR does NOT do
If any of those want polish after we see the deployed UX, that's follow-up.
Refs