feat(search): resultSource option shows where results come from

[piecioshka]

Summary

Search results for matches inside a section only show the section heading, with no hint of which page the result belongs to. On docs sites where many pages share similar section names ("Usage", "Options", "Examples"), it is hard to tell the results apart.

This PR adds a resultSource option to the search plugin that renders, below each result excerpt, where the result comes from:

• 'none' (default): current behavior, nothing extra renders
• 'page': the title of the page (its first heading), omitted when the matched title is the page title itself
• 'breadcrumb': the sidebar path to the page, e.g. "Getting started › Cover page", falling back to the page title for pages not present in the sidebar

window.$docsify = {
  search: {
    resultSource: 'breadcrumb', // 'none' | 'page' | 'breadcrumb'
  },
};

Implementation notes:

• genIndex() stamps every index entry with the title of its page (pageTitle), and search() exposes it on results as page
• the breadcrumb is computed at render time by walking the rendered .sidebar-nav tree from the link matching the result URL up to the root
• emoji in sidebar labels and page titles are stripped so the source line stays plain text; the label is right-aligned, slightly muted (--color-mono-7) and the page segment renders in <strong>
• default 'none' keeps the current behavior, so nothing changes for existing sites

Preview (resultSource: 'breadcrumb' on the docsify docs):

Related issue, if any:

None.

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

For any code change,

• Related documentation has been updated, if needed
• Related tests have been added or updated, if needed

Does this PR introduce a breaking change?

• Yes
• No

Tested in the following browsers:

• Chrome
• Firefox
• Safari
• Edge

[vercel]

@piecioshka is attempting to deploy a commit to the Docsify Team on Vercel.

A member of the Team first needs to authorize it.

[Copilot]

Pull request overview

This PR enhances the Docsify search plugin UX by adding a resultSource option that displays the originating page context for each search result (none/page title/sidebar breadcrumb), helping users distinguish similarly named sections across pages.

Changes:

• Add search.resultSource config ('none' | 'page' | 'breadcrumb') and propagate it through the plugin.
• Stamp search index entries with pageTitle and expose it on search results as page.
• Render and style a per-result “source” line (page title or computed sidebar breadcrumb), and add e2e coverage for the new option.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
test/e2e/search.test.js	Adds e2e tests for resultSource modes (default/page/breadcrumb).
src/plugins/search/style.css	Styles the new .search-breadcrumb line under each result.
src/plugins/search/search.js	Captures pageTitle during indexing and exposes it on search results.
src/plugins/search/index.js	Adds the resultSource config option and wires it into plugin config.
src/plugins/search/component.js	Renders source info for results; computes breadcrumb from the sidebar DOM.
docs/plugins.md	Documents the new resultSource option in plugin docs.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
docsify-preview	Ready	Preview, Comment	Jul 23, 2026 8:59am