Giter Site home page Giter Site logo

Implement / improve search about docs HOT 10 CLOSED

cucumber avatar cucumber commented on July 17, 2024
Implement / improve search

from docs.

Comments (10)

aslakhellesoy avatar aslakhellesoy commented on July 17, 2024 1

The site now has basic Lunr search

from docs.

aslakhellesoy avatar aslakhellesoy commented on July 17, 2024 1

We've got some basic lunr search now. Try it out: https://cucumber.netlify.com/documentation/

from docs.

plaindocs avatar plaindocs commented on July 17, 2024

https://www.npmjs.com/package/hugo-lunr

from docs.

olleolleolle avatar olleolleolle commented on July 17, 2024

Could one say that we’re waiting for launch to have Algolia? Or can it be configured already?

from docs.

plaindocs avatar plaindocs commented on July 17, 2024

We could easily configure Algolia with a the URL, compare it to the Lunr and then reconfigure before launch. Or just go with Lunr.

from docs.

mlvandijk avatar mlvandijk commented on July 17, 2024

Having the search is great.
Getting an overview of pages that might have what you are looking for is also nice.
However, when you go to one of the suggested pages, the list of suggested and the search term (whatever you typed into the search box) disappear. I think it might be nice if those could be kept, until the search box is explicitly cleared (in case the page you choose from the suggestions isn't what you were looking for; you don't want to have to search again (and again, and again) for the same thing...
Also, is there any way to get info on what people are searching for (and whether they find it), as that might provide feedback regarding missing docs / what is unclear? (this would be a nice to have / enhancement)
It might be a good idea to keep the search term / search results unless explicitly cleared in case

from docs.

aslakhellesoy avatar aslakhellesoy commented on July 17, 2024

Yep highlighting the search terms is on the todo list. Let’s keep this open until that’s done.

from docs.

mlvandijk avatar mlvandijk commented on July 17, 2024
  • Highlighing (see above)
  • Improve subtitles, based on description in the frontmatter. Make them consistent with subtitles shown in the menu
  • Add possibility to clear search box (i.e. by clicking an x and/or esc)

from docs.

mlvandijk avatar mlvandijk commented on July 17, 2024

Discussed on Cukenfest Open Space: switch to Algolia

from docs.

mlvandijk avatar mlvandijk commented on July 17, 2024

We seem to be using Algolia now. Closing this issue (also due to lack of activity)

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.