Search plugin: added option to put full nav path to the search result title

[lord-vesel]

Hi! Here is my first PR 😁

Added option full_path_in_title which allows to get not just page title in a search result, but full path separated with slashes, like: "Section 1 / Subsection / Page Title".

To enable the feature, one has to add following to mkdocs.yml:

plugins:
    - search:
        full_path_in_title: yes

Tests for search plugin is updated too.

[oprypin]

Hi. Thanks for the contribution. Sorry that I haven't looked it in detail yet.

Basically the main difficulty for a reviewer is... it's hard to decide whether this feature would have wide enough appeal to be "worth it".

The code seems to be high-quality at a glance, though.

I'll think about it more.

---

Here is my first PR

Something to keep in mind is that usually for any big open source project, the first thing you open should be an Issue. It's a better place to have an initial discussion, and an "opportunity" to get a rejection before putting work into an implementation. Some projects even require an issue to be opened, because there you can discuss the merits of the idea, and then discuss only implementation details in the pull request.

[oprypin]

You may also want to double-check that the email address you sign the commit with matches an email address in your GitHub account. As it is now, the commit wouldn't be attributed to your GitHub profile.

[oprypin]

It seems to be working wrong

Before:

After:

diff --git a/mkdocs.yml b/mkdocs.yml
index bfaeb5588..32fd9f5a4 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -7,7 +7,7 @@ repo_url: https://github.com/mkdocs/mkdocs/
 edit_uri: ""
 
 theme:
-    name: mkdocs
+    name: material
     locale: en
     analytics: {gtag: 'G-274394082'}
     highlightjs: true
@@ -53,7 +53,8 @@ markdown_extensions:
 copyright: Copyright &copy; 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.
 
 plugins:
-    - search
+    - search:
+        full_path_in_title: true
     - redirects:
         redirect_maps:
             user-guide/plugins.md: dev-guide/plugins.md

[lord-vesel]

It seems to be working wrong

Thanks, and I think I fixed it, now it doesn't mess up internal section titles, modifying only the first title for section.

[oprypin]

What happens when the page has no ancestors? Then the title is completely empty, and I think that's a problem. Or actually, I'm not noticing anything bad happening, but then why doesn't an empty title cause problems?

[oprypin]

Agh I don't understand how it works.

It seems that the search can lead you directly to an #anchor and then this change doesn't affect that, but it does affect when it sends to a page in general.

Shouldn't it be "User Guide / Configuration / nav" or something

[oprypin]

Note that I pushed my commit to your branch

[iagodvsantos]

Any plans to merge this PR? It would be useful in our context

[ossdhaval]

+1.
This feature would be useful to us too!! Path adds context to the search results, and that can help users decide which of the search result is the best fit.

[chuckwagoncomputing]

I had this idea myself, and here I find someone else had it before me! Please merge this. It would be super helpful for us, as we have headers that are identical to headers on other pages, and it's hard to figure out which page the search result is for.

[rusefillc]

@lord-vesel any chance to rebase?