-
Notifications
You must be signed in to change notification settings - Fork 344
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
Add algolia search #963
Add algolia search #963
Conversation
Hi @keynmol, Thank you for your contribution! We really value the time you've taken to put this together. Before we proceed with reviewing this pull request, please sign the Lightbend Contributors License Agreement: |
For the record I did apply for DocSearch yesterday. Since it's Thanksgiving weekend, it might take a few days to process? |
Ah yes, you're right. Either way, the wheels are turning and SBT site should be at the top of priority list as it's open source :) |
Hello! I got the API key.
|
And configuration is here - https://github.com/algolia/docsearch-configs/blob/master/configs/scala-sbt.json |
Yohoo! Let me update the PR and see what sort of results we get. I can also push the locally generated version termporarily to http://surge.sh so that you can have a play around |
Perhaps the indexing hasn't happened yet - I've pushed the site with new configs here: http://scala-sbt.surge.sh/index.html I can see requests going to algolia okay but the response doesn't contain any results. I'll see if the regex in their sbt config is correct. |
A-ha, the regex is indeed incorrect. It collects everything after /docs into a Which means if I remove the facet filter the search should work. |
We're live! (I pushed the change to the the http://scala-sbt.surge.sh/1.x/docs/ as well) But lack of facet does mean that visitors will learn a language or two :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Closes #962
To Algolia's credit, adding this was 5 minutes of following instructions and a whole day of CSS. Mostly because
layout.html
didn't do anything for some reason, so I had to add and remove lots of custom css.Plus there's duplication of
.st
pages.In the end I removed all the custom CSS and decided to make Algolia's base bootstrap theme to work properly first.
Outstanding:
@eed3si9n to apply for docsearch here: https://docsearch.algolia.com/docs/apply (sorry for picking on you Eugene, not sure what the full list of maintainers looks like :-)
Given that API key is public, once there's one I'll be able to test this locally without having to merge 🎉
Some CSS tweaks to match the theme?
Might be able to add language-localised to pages not in English, if it's worth it? I don't know how DocSearch's indexing works
Here's what it looks now with index pointing at scala-lang.org DocSearch