mkdocs-material
mkdocs-material copied to clipboard
squidfunk
Search: breadcrumbs to signal context of a document
Contribution guidelines
- [X] I've read the contribution guidelines and wholeheartedly agree
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
Might be nice to have breadcrumb-like context on search results, so it's more clear where each result fits in the overall IA of the site. This would provide meaning/context to help users decide whether a given search result represents what they're looking for.
For example, when I search for changelog on the Material for MkDocs site right now, here's what comes back:
I'm thinking some kind of small font, above the title of the doc, that has breadcrumbs leading up to the page associated with the result. So, the search results for changelog might be:
Getting Started > Changelog
Insiders > Getting Started > Changelog
Just an idea, feel free to close out!
Use Cases
Helps provide context when reviewing search results.
Screenshots / Mockups
No response
Thanks for suggesting! "Changelog" is exactly the evil example I had on my list for ages 😂 I'm planning to do a slight face-lift of the search at some point, probably later this year. Breadcrumbs might be a good idea, and since we have a new built-in search plugin anyway, we could add the necessary information to the pages. I'll investigate.
You can now have breadcrumbs on the page ^breadcrumbs if you use insiders-4.28.0 or higher. I did not find breadcrumbs for search in the Material for MkDocs manual though. Maybe having the breadcrumbs on the page figured out helps with getting it working for search later.
Seconded, this would be very useful to have! We have this issue with a lot of our common search terms
@squidfunk are there any news on this topic? I'd love for this to work, this would be a tremendous help in structuring and finding things in large scale documentation projects! :)
Still working on it. The new search is the next major feature that's coming out, and it will solve many, if not all of the change requests that are currently open and more. Please understand that this is a pretty big fish to fry, as we're implementing this from scratch, but you can definitely expect it to hit the shelves later this year.
If you can share your project, please do! It would be awesome to have some projects for testing this before shipping.
Still working on it. The new search is the next major feature that's coming out, and it will solve many, if not all of the change requests that are currently open and more. Please understand that this is a pretty big fish to fry, as we're implementing this from scratch, but you can definitely expect it to hit the shelves later this year.
Do I need a Insiders-membership pass to try your delicious bread-crumbed-fish then? 😉
If you can share your project, please do! It would be awesome to have some projects for testing this before shipping.
We use Material for MkDocs for the Renovate documentation. We have a lot of similar pages where the breadcrumb would help us. Here's a link to the renovatebot.github.io repository. You can use GitHub's Codespaces to get a preview of the site working quickly.