Add search functionality to the documentation platform

Description

Add search functionality to the documentation platform.

Searching will need to be a client-side solution since there is no database or a server.

Docpad has a search plugin called lunr:
https://github.com/brockfanning/docpad-plugin-lunr

Environment

None

Activity

Show:

Cindy Li July 8, 2019 at 5:29 PM

The pull request has been merged into the project repo master branch at this commit.

Tony Atkins [RtF] April 30, 2019 at 8:58 AM

Tony Atkins [RtF] April 17, 2019 at 11:46 AM

I recently revisited the options for search in a technology evaluation on the WIKI:

https://wiki.gpii.net/w/Technology_Evaluation_-_Static_Site_Search#Recommendation

After getting some small feedback from the group, my plan is to proceed to "spike" a proof-of-concept approach with Fuse.js.

Tony Atkins [RtF] March 16, 2017 at 8:51 AM

I read through the Tipue docs, they have support for stopwords, stemming, and field weighting. However, as they do not include useful data for stopwords and stemming, we'd have to roll our own or adapt someone else's body of data.

As far as I can see, there is absolutely no option to switch between languages, but if you're dealing with a static site that has different subdirectories by language, it's possible to have a different search index and stopwords per language.

Anyway, my overall impression of Tipue is that it seems like it would work, but it doesn't do all that much to help us bridge the gaps.

Tony Atkins [RtF] March 15, 2017 at 3:12 PM

Just to comment a bit further, the other things I'd want to read up on regarding this (or really any solution) would be:

  1. Support for stemming.

  2. Support for improving search quality using stopwords.

  3. Support for multiple languages.

Fixed

Details

Assignee

Reporter

Components

Priority

Created July 28, 2015 at 6:29 PM
Updated July 8, 2019 at 5:29 PM
Resolved June 30, 2019 at 10:38 PM

Flag notifications