-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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: breadcrumbs to signal context of a document #3787
Comments
Thanks for suggesting! |
You can now have breadcrumbs on the page 1 if you use Footnotes |
It's definitely coming with the next iteration of search 😊 |
@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. |
Do I need a Insiders-membership pass to try your delicious bread-crumbed-fish then? 😉
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 |
Please see the announcement in #6307. |
Contribution guidelines
I want to suggest an idea and checked that ...
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:Just an idea, feel free to close out!
Use Cases
Helps provide context when reviewing search results.
Screenshots / Mockups
No response
The text was updated successfully, but these errors were encountered: