nikon/docsearch
1
0
Fork 0
Code Activity Actions

feat: show page path breadcrumbs in Docusaurus search (#2790)

Browse source 
Co-authored-by: Paul Jankowski <33367713+8bittitan@users.noreply.github.com>
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
This commit is contained in:
Ahmed AbouZaid 2026-07-02 14:37:08 +04:00 committed by GitHub
parent 0e41a78c44
commit d3d707d875
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
packages/website/docs/templates.mdx
View file

@ -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: {

12
packages/website/versioned_docs/version-v3/templates.mdx
View file

@ -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: {