feat: show page path breadcrumbs in Docusaurus search #2790
+14
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aabouzaid
requested review from
8bittitan,
NatanTechofNY,
dylantientcheu,
pipeline1987,
shortcuts and
vascobettencourt
as code owners
👷 Deploy request for docsearch pending review.Visit the deploys page to approve it
|
aabouzaid
force-pushed
the
docusaurus-search-path-breadcrumbs
branch
from
0c78033 to
a0dfb51
Compare
Contributor
|
Thanks for this PR @aabouzaid. I'll find some time for a thorough review and I'll be back to you. |
✅ Deploy Preview for docsearch-demo ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
8bittitan
approved these changes
Nov 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi 👋
Docusaurus and other docs CMSs are hierarchical by design (i.e., the same page title can appear under different sections).
However, the recommended Docusaurus v2 & v3 Template doesn't display the page path in the search dialog, which significantly affects the UX, as the user cannot determine the page's full path.
This change utilizes the built-in Docusaurus Sidebar Breadcrumbs (enabled by default) to show the path of the page. It is not just about the UI, but also enhances the search results as the full path is included in the Algolia index.
You can see the change in action on Camunda Docs.