Search function for documents hosted on OpenDRR and DRRPathways.ca

[anthonyfok]

Joost wrote on 2021-03-02:

Hi Anthony, can you add an issue in opendrr-platform repo to address the search function that we discussed with Sahar yesterday please. Self assign and put in the backlog for now. Thanks!

Thank you Joost!

(Might be experimenting with both GitHub's built-in search feature... or maybe not.)

Lightweight full-text JavaScript-based search engines:

Algolia DocSearch

• Instantaneous ype-as-you-go result display, and very pretty!
• Examples:
  • ":mag: Search the Docs" on https://gohugo.io/ (source: https://github.com/gohugoio/hugoDocs)
  • Jekyll Search with Algolia and Webtasks | Forestry.io
  • Static site search with Hugo + Algolia | Forestry.io
  • Adding Search with Algolia | Gatsby
• Free tier: 10 units/month, i.e. up to 10,000 searches/month and up to 10,000 records; see https://www.algolia.com/pricing/
• Perhaps we qualify for the Algolia for Open Source plan? See https://www.algolia.com/for-open-source/
  • Equivalent to "Standard PAYG plan and to include 200 units for free which translates to 200,000 records and 200,000 search requests (and up to 2,000,000 indexing operations) per month (a $180/month value)."

Other options

lunr.js, elasticlunr.js, Fuse.js, QuickScore, etc. Lots of options to choose from. Some lists:

• Search for your Hugo Website | Hugo
• QuickScore | A JavaScript string-scoring and fuzzy-matching library based on the Quicksilver algorithm, MIT License - This looks quite impressive (based on its demo comparison with Fuse.js), though probably not as well-known yet.