search via jquery

[inetbiz]

• This is a feature request.

---

Environment informations

N/A

Expected behavior

Output search results on a search page using jquery

[mmistakes]

This is something you can add with a plugin or the addition of a simple script and .json file.

See this issue as others have it working with the theme.

#588

[nickgarlis]

I've got it working for my site. @mmistakes do you want me to pr ?

Here is what it looks like:

[ohadschn]

+1 from me, built-in search would be great. The other threads suggest using those plugins can be a hassle.

[igoratencompass]

+1 from me too it's really a PITA setting it up

[ohadschn]

One important note to make is that jekyll-lunr-js-search says "UNSUPPORTED" in its GH page, and the new kid on the block looks to be https://github.com/christian-fei/Simple-Jekyll-Search.

[mmistakes]

Any solution I add will likely still be a pain to setup as it require a search page to be created. Similar to the category/tag implementation.

One of my other themes has search built in and it's fairly fragile and not something I enjoy supporting which is why I've left it out of this theme.

[mmistakes]

Simple Jekyll Search is hardly new. I've used it in a few projects and it has the same flaw as most. The json you need to build to act as a search index is easy to break with malformed data.

[ohadschn]

How about just a UI placeholder for the search box then?

Getting the search script/engine running properly could probably be done without too many issues, but what really worries me is where and how to place the search box (and have it behave properly relative to all the other UI elements in different resolutions, on mobile, etc).

[mmistakes]

That worries me to as I don't have a good place to put it without completely gutting the masthead/navbar 😐

[ohadschn]

Could it perhaps be treated exactly like a navigation item (just like e.g. "About" and "Sample posts" in your demo site)?

[mmistakes]

That's probably how I'd handle it. Cue PRs and issues asking for it to be placed first/last in the list, always be visible, and various other custom placements 😂

[ohadschn]

Haha those pesky users :)

I really think it would add a lot of value even without all those features. I can handle the great responsibility of putting it first in navigation.yml, and if the screen is small enough that it gets inside the hamburger, so be it...

[mmistakes]

You might be able to, but the vast majority of users in academia using my theme as a simple way to spit out Markdown docs usually can't. Jekyll in general is a steep learning curve just because of all the baggage you need to be familiar with (Markdown, setting up a Ruby environment, HTML/CSS best practices, etc.)

For something I put out there for free expectations need to be kept in check. Bootstrap or a premium Wordpress theme this project is not.