-
Notifications
You must be signed in to change notification settings - Fork 204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
meta: Replace lunr (middleman-search) with DocSearch #691
Comments
There's also typesense which describes itself as "The Open Source Algolia Alternative". |
Yes, typesense cloud is not at no cost even for open source project while typesense software is fully open-sourced. DocSearch equips (user-facing) UI kit specialized for document search as its name suggests. DocSearch (and Algolia in small amount) is to typesense cloud what GitHub is to GitLab. GitLab is an open-sourced project but (GitLab as cloud service) is getting less and less for open source project (a personal opinion). Anyway, thanks for replying to my "Cons". |
Maybe we can ask typesense for some kind of "free" community program. /cc @kishorenc |
@simi We'll be delighted to help! |
https://typesense.org/docs/guide/docsearch.html looks like getting started 😁 |
With a proof of concept in #702, at this moment I prefer Algolia's DocSearch as it is for free, provides automated crawling every 24 hours and new look and feel so-called as DocSearch v3... |
@tnir I work with @kishorenc on Typesense. DocSearch v3 also works with Typesense. Here’s one site that uses it: https://rushjs.io/. Happy to also host the scraper for you, and set it up to crawl on-demand on each deploy, so the index is updated in near real-time. Let me know. P.S.: I’m a big Ruby fan, the Typesense Cloud management console is built on Rails, so I’m very excited to be able to support the Ruby ecosystem in anyway I can! |
@jasonbosco Thanks for your reply. While I could not find any clue about DocSearch v3-compatible On development of this, I also found https://github.com/typesense/typesense-docsearch.js seems having no update more than 18 months 😭 Thanks for hosting the scraper, but can we monitor it like one at Algolia's crawler? P.S. I was a (big) Typesense fan last summer. When I just logged in today 1 year after it, I found my personal account is disabled 😭. |
@jasonbosco Two questions in summary:
|
Rushjs.io uses Docusaurus and so they use the Docusaurus Typesense theme, which in turn uses typesense-docsearch-react. I haven't yet published a non-React version of typesense-docsearch v3. So we can do one of two things:
Let me know which one you'd prefer.
I intend to maintain the Typesense fork of Docsearch well into the future, as new versions of Docsearch come out.
The
We don't have a monitoring UI for the scraper specifically, but happy to share access to logs that the scraper generates.
I've gone ahead and reinstated your account. In any case, you would want to provision clusters under a team account in case cluster access needs to be shared. The best way to do this would be to create a new (free) Github Org just for this purpose call it say Alternatively, you could also authorize access to the To reauthorize your own account, you want to visit https://github.com/settings/applications, remove Typesense Cloud and then log out and log back in to Typesense Cloud. Github will then prompt you to allow access to the new Github org. |
@jasonbosco Thank you. I will reconsider the architecture between Algolia and Typesense. I hope you prepare docs for Typesense's open source program. Otherwise, it is hard to compare it with competitors. |
@tnir Following up from this:
I just published v3 of DocSearch which has the modal layout ((2) above), customized to work with Typesense. Here's how to use it: https://typesense.org/docs/guide/docsearch.html#option-c-custom-docs-framework-with-docsearch-js-v3-modal-layout |
This issue is for the replacement of home-made search system based on unmaintained middleman-search. I would like to ask @jasonbosco and everyone interested in to move to the dedicated issue #731 per Typesense-specific discussion. Thank you 🚀 |
Loading index on every page (no cache on browser side as of writing) can be avoided with this improvement. Adding this to pros.
|
Un-assigning myself as it is now meta-ish. |
Problems
The Bundler.io Website team needs to maintain our own
search.js
andsearch_arrow.js
by themselves with that abandoned middleman-search (for example manastech/middleman-search#38) and its dependency of the legacy version lunr.js.We cannot upgrade lunr to the latest without our efforts (or other community's efforts than maintainers).
This also prevents from merging #661.
Solutions
https://github.com/algolia/docsearch (do not confused with
https://docsearch.algolia.com/
) can be utilized.Pros
lunr-index.json
is not required any more.search.js
andsearch_arrows.js
can be replaced with Algolia's one, which seems sophisticated to me.Cons
The text was updated successfully, but these errors were encountered: