Breadcrumbs for Search

[stollero]

Context

Having larger documentation, the chances are high that titles are not unique.

Description

Having breadcrumbs for the search instead of just the title will help to provide the context needed to find the right search result faster.

Having prototyped it may only be a smaller change in SearchIndex.create_entry_for_section, which I could implement.

        if page.ancestors:
            chapters = [i.title for i in page.ancestors]
            chapters.reverse()
            title = " → ".join(chapters + [title])

We could also add a search setting to enable or disable this behaviour.

Related links

• Requesting a change
• Towards better documentation search  #6307

Use Cases

Provides better overview

Visuals

Before submitting

• I have read and followed the change request guidelines.
• I have verified that my idea is a change request and not a bug report.
• I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
• I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.

[squidfunk]

Thanks for suggesting! This is an exact duplicate of #3787. We've already solved this as part of #6307, but we're working on another big topic which must predate the release of search. There will be an announcement later this year, so stay tuned ☺️

Please understand that we're currently not considering PRs for the search plugin, since it will have a fundamentally different design in the near future, and adding new features would make more work for us to maintain. However, you could fork the plugin and adapt it to your needs, and release it as a separate plugin, as long as the format does not change.