feat: add pagefind search #4247
Draft
Conversation
This file contains 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
Instead of using sphinx's built-in search which has some challenges in its implementation, as well as the integration with the customized builder and theme, use a different approach. Pagefind will generate fragments that can be loaded client-side efficiently. Refs: https://pagefind.app/ Refs: https://pypi.org/project/pagefind/ Signed-off-by: Mike Fiedler <[email protected]>
miketheman
force-pushed
the
pagefind-search
branch
from
ddc20a4 to
3d3d32c
Compare
|
Definitely needs more styling, and I put it at the top of the sidebar since that made sense to me, but it might be better elsewhere. Left a TODO - I'm not sure how/when the nodes attributes are getting cleared after But give it a whirl! |
|
The search box looks a little big to me, and it displays "Python Enhancement Proposals" instead of the page titles. But it already looks promising. |
|
@miketheman I'm not familiar with pagefind. I tried the preview site and it works well. Thank you! |
|
Thanks gang! Definitely needs some styling, and mobile theme integration, since that doesn't appear to work on my phone yet. |
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.
Instead of using sphinx's built-in search which has some challenges in its implementation, as well as the integration with the customized builder and theme, use a different approach.
Pagefind will generate fragments that can be loaded client-side efficiently.
Refs: https://pagefind.app/
Refs: https://pypi.org/project/pagefind/
📚 Documentation preview 📚: https://pep-previews--4247.org.readthedocs.build/