[Closes #1325] Documentation Search

[patrickdaze]

This is a documentation fix.

Proposed solution

Using Algolia's DocSearch for scraping, indexing, understanding the documentation’s hierarchy, and displaying search results. It would close #1325.

The scraper indexes the latest/current documentation hosted on https://bulma.io/. It also indexes previous versions of the documentation hosted on https://versions.bulma.io/ starting at version 0.6.2 (since there was no search before this version).

Tradeoffs

The solution relies on a third-party (Algolia) to scrape and index new content. DocSearch is however used by many reputable projects such as Bootstrap, Vue.js, React, and many others.

The alternative is to use something like jekyll-algolia which would rebuild a new index before deploying a new documentation version. It however requires more development, and configuration. Mainly it would require custom hooks written in Ruby to reorganize the content before sending it to Algolia.

Testing Done

Most of the solution relies on the DocSearch JavaScript and styles. Not much custom code was written. Initial testing is done using the docsearch-scraper.

For testing locally, append the Algolia testing app to your Jekyll configuration.

Launch Requirements

• Create initial DocSearch frontend implementation
• Create the DocSearch configuration
• Collaborate with Algolia to implement the DocSearch configuration (comment about this below)
• Finalize frontend design (this PR / discussion at Search for Bulma docs #1325)
• Update _config.yml with key and index provided by Algolia
• Update repo's documentation (if required)

[patrickdaze]

If the Bulma team agrees, I suggest that the next step would be for me to open a PR with the DocSearch configuration. This would initiate the conversation with Algolia.

Alternatively the Bulma team can start a conversation by filling-in the form on the DocSearch website. Once Algolia replies, the Bulma team can mention the configuration branch.

[patrickdaze]

@jgthms is this PR heading in the right direction?

There's just two main things left: agree/disagree with design, and initiate conversation with Algolia.

[patrickdaze]

I noticed the website layout has change since I created this PR. If still interested, let me know and I can update this PR to match it.

cc @jgthms

[san-kumar]

This was a really good thing. Right now it takes forever to search something as simple as is-grouped, is-gapless, etc. Any updates on this?

[diomed]

@jgthms whole community would benefit from search integration very much.
[it's powerful and free for open source projects]

[wtfluckey]

🙏 Please, please, please!

[ahstro]

How has this not been merged yet?

[Shipow]

Hello Bulma team, I'm working for Algolia and I'm super excited to see DocSearch on this docs!
Do you need any help to get this PR merged? Is there any issue I could help to solve with the index?
Let me know ^^

[Maxhodges]

please note

#2374

i'll eat my own dick if he merges this PR

[Shipow]

Oh, wow, sensing a bit of frustration there :)
I've been familiar with that feeling in the past but it's easy to get lost in issues, PR, priorities, life and stuff.
Of course I'd recommend the great talk of Fat about maintaining a successful open source project to get a better idea on how hard it can be. Open source is full of compromises and challenges. I believe Bulma is an awesome project that will continue to grow at it's own pace! Respect for everything already achieved.

[patrickdaze]

As this thread has proven, the lack of search for the open source Bulma project is frustrating for the community. This is why @ThomasEdwards and myself (@patrickdaze) have been working on two projects.

The first is Bulma Search. It provides indexing and search through Algolia.

The second is Search for Bulma : Chrome Extension, a chrome extension that uses Bulma Search.

Both projects are not affiliated with nor developed by the core Bulma team. Feel free to send us PRs.

[a-kriya]

@patrickdaze Can probably be closed now : ]

[patrickdaze]

✌️