squidfunk
Search: facet/filter by metadata, e.g. `tags` or `categories`
Description
Today, it is possible to filter search results "by tag" with the following syntax: +<my_tag> my_query>. Note: this is not completely correct as all the documents that contain my_tag will be returned not only the ones that define this tag.
For users, it requires 2 things:
- They should know the available tags
- They should know how to filter "by tag"
Providing a menu where you can select the tags (so you immediately see the available tags) would be more user-friendly
Use Cases
For large documentation, the search functionality could take part of the tag system to make it easier to filter the results avoiding having too many results in one view
Visuals
As an example, see the search bar UI of this website (powered by Algolia). On the left, there is a menu with the available tags
Note: FYI I found this old issue to integrate DocSearch into the mkdocs-search plugin
Before submitting
- [X] I have read and followed the change request guidelines.
- [X] I have verified that my idea is a change request and not a bug report.
- [X] I have ensured that, to the best knowledge, my idea will benefit the entire community.
- [X] I have included relevant links to the documentation, related issues and discussions to underline the need for my idea.
I've started working on the next big search update which will include the ability to list and better select available metadata like tags, authors, etc. This will allow to customize the search in a way that wasn't possible before.
