sbt-typelevel icon indicating copy to clipboard operation
sbt-typelevel copied to clipboard

Search for sbt-typelevel-site

Open armanbilge opened this issue 3 years ago • 7 comments

I discussed this once with @valencik. The rough idea would be to generate a search index with Apache Lucene and feed it into lunr.js. Or something ...

See also:

  • https://github.com/http4s/http4s/issues/5457

armanbilge avatar May 01 '22 22:05 armanbilge

I think this is a really important feature for documents. If there's no progress on this issue, could you please consider using DocSearch?

kevin-lee avatar Sep 03 '22 13:09 kevin-lee

@Kevin-Lee thanks, I also think this is very important.

Sure, how would a DocSearch integration work? It seems to me that each project would need to apply independently?

armanbilge avatar Sep 03 '22 13:09 armanbilge

@armanbilge Yes, you're right. As far as I know, each project should have its own application separately. However, once application is submitted then it requires to reply to one confirmation email from DocSearch and that's it.

kevin-lee avatar Sep 03 '22 13:09 kevin-lee

Cool! That sounds pretty straightforward :)

Does anyone want to experiment with adding DocSearch to a Laika site? So we can get an idea of what the integration is like?

armanbilge avatar Sep 03 '22 13:09 armanbilge

@armanbilge To clarify, it's an application per a doc site. So for example, For Cats, DOCUMENTATION OR BLOG URL: https://typelevel.org/cats REPOSITORY URL: https://github.com/typelevel/cats

Once connected, you can monitor it through https://www.algolia.com and you will also have access to its Crawler. So I recommend you use one email address to create a Algolia account if you want to monitor all TypeLevel doc sites. If each site has a different owner, you probably want to use the owner's email.

I also recommend reading this page.

kevin-lee avatar Sep 03 '22 14:09 kevin-lee

This is happening!!

https://cozydev-pink.github.io/protosearch/

With a demo: https://cozydev-pink.github.io/protosearch/searchdocs/index.html

armanbilge avatar May 12 '23 18:05 armanbilge

@armanbilge That's awesome! Thank you so much!

kevin-lee avatar May 13 '23 10:05 kevin-lee