Skip to content
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

Search for sbt-typelevel-site #267

Open
armanbilge opened this issue May 1, 2022 · 7 comments
Open

Search for sbt-typelevel-site #267

armanbilge opened this issue May 1, 2022 · 7 comments

Comments

@armanbilge
Copy link
Member

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:

@armanbilge armanbilge changed the title Search for docs site Search for sbt-typelevel-site May 1, 2022
@armanbilge armanbilge pinned this issue Jun 1, 2022
@kevin-lee
Copy link

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

@armanbilge
Copy link
Member Author

@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?

@kevin-lee
Copy link

@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.

@armanbilge
Copy link
Member Author

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?

@kevin-lee
Copy link

@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.

@armanbilge
Copy link
Member Author

This is happening!!

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

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

@kevin-lee
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants