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: facet/filter by metadata, e.g. tags or categories #4983

Open
4 tasks done
albtam opened this issue Feb 3, 2023 · 2 comments
Open
4 tasks done

Search: facet/filter by metadata, e.g. tags or categories #4983

albtam opened this issue Feb 3, 2023 · 2 comments
Labels
change request Issue requests a new feature or improvement

Comments

@albtam
Copy link

albtam commented Feb 3, 2023

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:

  1. They should know the available tags
  2. 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

image

Note: FYI I found this old issue to integrate DocSearch into the mkdocs-search plugin

Before submitting

@squidfunk squidfunk added needs investigation Issue must be investigated by the maintainers change request Issue requests a new feature or improvement and removed needs investigation Issue must be investigated by the maintainers labels Feb 3, 2023
@squidfunk
Copy link
Owner

squidfunk commented Apr 9, 2023

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.

@squidfunk squidfunk changed the title Provide tags as a menu in the search bar Search: display list of tags in search bar Aug 10, 2023
@squidfunk
Copy link
Owner

Please see the announcement in #6307.

@squidfunk squidfunk changed the title Search: display list of tags in search bar Search: facet/filter by metadata, e.g. tags or categories Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement
Projects
None yet
Development

No branches or pull requests

2 participants