Skip to content

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

@albtam

Description

@albtam

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    change requestIssue requests a new feature or improvement

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions