Skip to content

feat: show page path breadcrumbs in Docusaurus search #2790

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.

Sign up for GitHub

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

Open
aabouzaid wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −10
Open

feat: show page path breadcrumbs in Docusaurus search #2790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0dfb51
feat: show page path breadcrumbs in Docusaurus
aabouzaid Oct 28, 2025
5311d2d
Merge branch 'main' into docusaurus-search-path-breadcrumbs
8bittitan Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions packages/website/docs/templates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,12 +296,14 @@ new Crawler({
pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
recordExtractor: ({ $, helpers }) => {
// priority order: deepest active sub list header -> navbar active item -> 'Documentation'
// Extracting the breadcrumb titles for better accessibility.
const navbarTitle = $(".navbar__item.navbar__link--active").text();
const pageBreadcrumbTitles = $(".breadcrumbs__link")
.toArray()
.map((item) => $(item).text().trim())
.filter(Boolean);
const lvl0 =
$(
'.menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active'
)
.last()
.text() || 'Documentation';
[navbarTitle, ...pageBreadcrumbTitles].join(" / ") || "Documentation";

return helpers.docsearch({
recordProps: {
Expand Down
12 changes: 7 additions & 5 deletions packages/website/versioned_docs/version-v3/templates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,12 +296,14 @@ new Crawler({
pathsToMatch: ['https://YOUR_WEBSITE_URL/**'],
recordExtractor: ({ $, helpers }) => {
// priority order: deepest active sub list header -> navbar active item -> 'Documentation'
// Extracting the breadcrumb titles for better accessibility.
const navbarTitle = $(".navbar__item.navbar__link--active").text();
const pageBreadcrumbTitles = $(".breadcrumbs__link")
.toArray()
.map((item) => $(item).text().trim())
.filter(Boolean);
const lvl0 =
$(
'.menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active'
)
.last()
.text() || 'Documentation';
[navbarTitle, ...pageBreadcrumbTitles].join(" / ") || "Documentation";

return helpers.docsearch({
recordProps: {
Expand Down