mkdocs-material icon indicating copy to clipboard operation
mkdocs-material copied to clipboard

Feature Request: Sidebar search filter

Open josegonzalez opened this issue 2 years ago • 0 comments

Contribution guidelines

I want to suggest an idea and checked that ...

  • [X] ... to my best knowledge, my idea wouldn't break something for other users
  • [X] ... the documentation does not mention anything about my idea
  • [X] ... there are no open or closed issues that are related to my idea

Description

This is something I noticed in the Hashicorp docs. There is a sidebar filter (under the version dropdown) that folks can use to filter what is shown in the sidebar. While I don't think it should be the default (especially for smaller doc sites) it can be useful for larger doc sites (or those with many embedded pages).

Use Cases

The dokku docs have a very long sidebar, and it would be nice to be able to filter things.

Screenshots / Mockups

Attached is a screen recording of the usage of the docs site:

https://user-images.githubusercontent.com/65675/191110606-4af37f0b-81ab-4781-9658-49987455e740.mov

josegonzalez avatar Sep 19 '22 20:09 josegonzalez