Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.6k
feat: add pagefind search#4247
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Instead of using sphinx's built-in search which has some challengesin its implementation, as well as the integration with the customizedbuilder and theme, use a different approach.Pagefind will generate fragments that can be loaded client-sideefficiently.Refs:https://pagefind.app/Refs:https://pypi.org/project/pagefind/Signed-off-by: Mike Fiedler <miketheman@gmail.com>
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. |
Uh oh!
There was an error while loading.Please reload this page.
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/