EddieHubCommunity
[FEATURE] Searchbar Enhancement in Docs
Description
We Can add a searchbar in the docs to discover completely, It can also help in navigating many things in a short time and it can ultimately give a ease the learning of docs by its own interest.
Screenshots
Additional information
No response
To reduce notifications, issues are locked until they are https://github.com/EddieHubCommunity/LinkFree/labels/%F0%9F%8F%81%20status%3A%20ready%20for%20dev and to be assigned. You can learn more in our contributing guide https://github.com/EddieHubCommunity/LinkFree/blob/main/CONTRIBUTING.md
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Good suggestion. We need to give some thought as to how this would be implemented, so I have added the label talk: discussion to see what the community comes up with.
Found this on the internet while exploring options: https://docsearch.algolia.com/
How about implementing this?
Found this on the internet while exploring options: https://docsearch.algolia.com/
How about implementing this?
This is a great tool. Even TailwindCSS website uses it who's search is my favourate. Only problem is, it not free after certain requests ...
Looking for opensource free alternatives is better, else contact the admin for financial support. I will look for some opensource free alternatives.
!assign
@786-aquib please familiarise yourself with our Contributing Guide. Assignments should only be request when the label status: ready for dev has been added to the Issue.
For implementing the search DocSearch Algolia is a good option, also they offer free service to qualified open-source projects. (Algolia for open-source)
Typesense is another open-source alternative that can be useful.
Docusaurus is an open-source project by Meta for documentation. It offers versioning, easy i18n, and search using Algolia. Although it will be a big task to migrate entirely. But if we look in the long run, the features that Docusaurus offer will be very helpful.
Currently, if we are looking for a search only then the first 2 options are good.
As we are already using Mongo and this has full text search, we should look at this option.
As we are already using Mongo and this has full text search, we should look at this option.
Hello @SaraJaoude : Will anyone need assistance implementing the full text search functionality within Mongo? I'm reading up on this issue for the first time and wondered how I might be able to assist.
As we are already using Mongo and this has full text search, we should look at this option.
Hello SaraJaoude : Will anyone need assistance implementing the full text search functionality within Mongo? I'm reading up on this issue for the first time and wondered how I might be able to assist.
@waellerbe thank you for your comment. As this issue has the label talk: discussion at the moment and if you have any thoughts on how the implementation can be made please do note them down in a comment.
I'm also including our Contributing Guide so that you can familiarise yourself with the project's requirements, particularly the process of assigning issues - should you wish to work on this issue once it becomes ready.
Fuse.js - Powerful, lightweight fuzzy-search library, with zero dependencies.
What is fuzzy searching? Generally speaking, fuzzy searching (more formally known as approximate string matching) is the technique of finding strings that are approximately equal to a given pattern (rather than exactly).
Key Points:
- With Fuse.js, we don’t need to setup a dedicated backend just to handle search.
- It's a open source project - Fuse Github
- Fuse.js has no DOM dependencies.
- Demo of Fuse.js - Live Demo
Our approach to implement search would be something like this,
- We need to pre-convert .mdx file into single JSON format (like titles, specific words, etc.).
- When user search, we simple search the JSON data using Fuse instance.
- Return relevant results .mdx page and show it in search result component.
Thank you @Kamaruddheen this looks interesting!
ℹ️ eddiejaoude has some opened assigned issues: 🔧View assigned issues
