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.

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

Add search #1

Closed
koppor opened this issue Jan 26, 2016 · 7 comments
Closed

Add search #1

koppor opened this issue Jan 26, 2016 · 7 comments

Comments

@koppor
Copy link
Member

koppor commented Jan 26, 2016

It would be good if we had an instant search for the help. Currently not possible using gh-pages. Proposals at stackoverflow: http://stackoverflow.com/a/28553417/873282

@Siedlerchr
Copy link
Member

I will try around with this idea:
https://github.com/christian-fei/Simple-Jekyll-Search

@koppor
Copy link
Member Author

koppor commented Sep 16, 2016

Reading the above stackoverflow article and inspecting https://github.com/slashdotdash/jekyll-lunr-js-search closer, I came to following feature wishes:

  • full text search
  • display preview of results

This is not achieved by any plugins, so I played around with Google Custom Search available at https://github.com/JabRef/help.jabref.org/tree/add_google_custom_search.

Here an example:

grabbed_20160916-163558

Issues

Currently, too much effort for me to solve.

@tobiasdiez
Copy link
Member

Could we nonetheless merge the current version? It looks a bit unfinished but is better than no search at all. And maybe somebody else fixes the last issues.

@Siedlerchr
Copy link
Member

What about the SimpleSearch I posted above?
Example: http://christianfei.com/Simple-Jekyll-Search/

@koppor
Copy link
Member Author

koppor commented Sep 16, 2016

https://github.com/christian-fei/Simple-Jekyll-Search does full-text-search, but no preview of the results.

Further, we estimate that at the search page, ~3MB of (uncompressed) JSON is transferred to the user. This is not that mobile friendly, but could be OK for the desktop user.

@Siedlerchr
Copy link
Member

Ah okay. I think we can style the Google Custom search:
http://digitaldrummerj.me/blogging-on-github-part-7-adding-a-custom-google-search/

There is already stylesheet code

@koppor
Copy link
Member Author

koppor commented Sep 16, 2016

I did a straight-forward integration by scoping our markdown styling hacks (adding jabrefcontent as precondition). Good enough now. Feel free to play around with CSS 😇

@koppor koppor closed this as completed Sep 16, 2016
Avikrit10 pushed a commit to Avikrit10/help.jabref.org that referenced this issue Oct 10, 2019
Added 1 new java file, updated 1 existing
teertinker added a commit that referenced this issue Nov 21, 2020
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

No branches or pull requests

3 participants