feat: add algolia docsearch #1034
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TODO - get algolia indexing beta.spec.filecoin.io and update the index name - get algolia api key - improve narrow screen layout License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
and with that, fancy search arrived! License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
|
This has been updated to work with single page mode, but it will return results that link to the multipage site until algolia's next scrape which should be sometime today. (they scrape beta.spec.filecoin.io every 24hrs, and single-page mode got merged yesterday) |
|
@olizilla this is more than 3 years old now -- is this PR still relevant, or can I close it? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Integrate Algolia DocSearch into the site as per https://docsearch.algolia.com/docs/dropdown, along with UI fixes required to make it work... we have to pull the search bar out of the scrollable area, otherwise the search results are cropped / appear under the main body content. As such this pulls the header and search bar out of the nav, so it's just the TOC that scrolls.
Docsearch is like algolia premium. We dont have to set up algoila indexing at all, just add a js script to the page and they do all the scraping. Without that, we have to import our content to their servers and set up an action to re-import it when the main branch changes. With docsearch they scrape the deployed site for for us every 24 hours. For the curious, they maintain a public repo with the > 2k other docs sites that they index: https://github.com/algolia/docsearch-configs/tree/master/configs
typo proof search results
TODO:
Fixes #984
License: MIT
Signed-off-by: Oli Evans oli@tableflip.io