search

bridgetownrb / bridgetown

A next-generation progressive site generator & fullstack framework, powered by Ruby
https://www.bridgetownrb.com
MIT License
1.13k stars 114 forks source link

feat: Add or Document search capabilities #17

Closed westonganger closed 3 years ago

westonganger commented 4 years ago

Is it possible that bridgetown could implement or document some sort of basic search capability. I feel this is a very critical aspect of websites that is often overlooked by static site generators.

jaredcwhite commented 4 years ago

That would be super useful, for sure. In the past I used a customized version of a plugin for Jekyll that used a JS package that could search tokens generated in a JSON at build time. I should see if we can implement something similar, perhaps as an officially-sanctioned Bridgetown plugin.

westonganger commented 4 years ago

Great sounds good. If implemented as a plugin, I would also like to see a page about it directly in the main docs.

jaredcwhite commented 4 years ago

Making a note here we'll likely base a solution off of: https://lunrjs.com

It's worked well for me in the past and other plugins in the Jekyll world have utilized it…

jaredcwhite commented 4 years ago

image

It has begun! Coming soon to a Bridgetown website near you.

jaredcwhite commented 4 years ago

Check out the search working now on the beta website! Plugin will be widely available when 0.15 is officially released:

https://beta.bridgetownrb.com

jaredcwhite commented 4 years ago

This plugin is now out in the wild alongside the release of Bridgetown 0.15!

https://github.com/bridgetownrb/bridgetown-quick-search

Wondering how I could fit in a mention of this into the docs somewhere…

jaredcwhite commented 3 years ago

Finally. 🤯 https://www.bridgetownrb.com/docs/core-concepts#adding-extra-features-to-your-site