Skip to content
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

Jump to bottom

ENH: Offline search using JS index #184

Closed
davfsa opened this issue Apr 18, 2020 · 3 comments · Fixed by #209
Closed

ENH: Offline search using JS index #184

davfsa opened this issue Apr 18, 2020 · 3 comments · Fixed by #209
Assignees
@davfsa
Labels
enhancement New feature or request

Comments

@davfsa
Copy link
Contributor

davfsa commented Apr 18, 2020

At the time of opening this issue, the search bar consists of a google search bar.

It would be nice for pdoc to have a offline search bar (something like what sphinx has) to have a faster, non third party, offline way of searching the docs.
@kernc kernc added the enhancement New feature or request label Apr 18, 2020
@kernc kernc changed the title [Enhancement] Search bar ENH: Offline search using JS index May 23, 2020
@kernc kernc mentioned this issue May 23, 2020
Closed
@davfsa
Copy link
Contributor Author

davfsa commented May 31, 2020

@kernc Mind assigning this to me? I have found a way to easily implement this. I will leave comments in this issue as I implement it :)

@davfsa
Copy link
Contributor Author

davfsa commented May 31, 2020

image
All the HTML done, time to hook it up and make the results page

@davfsa
Copy link
Contributor Author

davfsa commented Jun 7, 2020

Everything is basically done, its working as intended and looks really nice. I'm still adding some CSS and making it look a bit better and then I will open a PR
image

@davfsa davfsa mentioned this issue Jun 8, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@davfsa davfsa

Labels
enhancement New feature or request
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Offline search with lunr.js
2 participants
@kernc @davfsa