Mkdocs-material: Improve search results and highlighting

[squidfunk]

The search results are really confusing - some entries occur twice as this is how the search index is built. This should be improved.

Current:

Proof of concept with search highlighting and improved filtering:

[facelessuser]

Curious. The search index reduction. Is this something that should be considered for MkDocs to do?

[squidfunk]

I'm integrating this into Material and when the plugin API is ready I will check if it's possible to do it as a general plugin

[facelessuser]

Makes sense. I was just thinking that if the index was fundamentally problematic, it's be nice if it could just be formatted better for all and save a theme from doing all the post processing. Plugin API makes sense. Anyways, this looks interesting.

[squidfunk]

It's a proof of concept. I will definitely propose the post-processing steps to the original MkDocs project, because currently search index really sucks. Also some parts are partly missing like admonition blocks etc. However, I want to see how far I can push this with some tweaking. The search experience is so much better, just with the highlighting. Some more ideas to come. Updates here.

[facelessuser]

This seems so much more practical. It always only showed the header with a little context, so often your found word(s) wouldn't even be in the preview. And since it only jumped to headers, it just seems pointless to have all those extra entries. I really like the direction you are heading with this.

[squidfunk]

Sections are now grouped by documents - finally there's context. Making good progress on this lately, should be ready soon.

[mattwelke]

This looks really nice. I love it compared to what it has now. Can't wait to see this released.

[squidfunk]

Implemented in #217, merged in master. Will be part of 1.4.0 which will be released shortly.

[squidfunk]

1.4.0 was just released.