feat: support facet filters for docsearch #3026
Merged
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.
Purpose
Extend the configuration parameters of docsearch to support facets.
Docsearch has something called 'facets' where you can restrict the results based on record attributes in the indexed results. E.g. if the crawler extracts version information from your pages you can restrict search results to latest. See
https://docsearch.algolia.com/docs/docsearch-v3/#filtering-your-search
Fixes #3022
Documentation
https://bootstrap.hugoblox.com/hugo-tutorials/search/#docsearch
If you like to limit the results of your search to specific topics, you can define
facetFilters
based on the attributes indexed by the algolia crawler. This is useful to limit search results for example to specific language or a specific version (e.g.version:latest
). Details on the required docsearch configuration can be found here.Adding DocSearch meta tags can be added to your site by creating a customized head-end hook based on page frontmatter.