Search input is disappeared after update

[andreygladilin]

I use mkdocs material+mike+gitlab pages. Unfortunately, after regular update of my documentation on 10th of Jan 2023 the Search field is disappeared from my site.

[squidfunk]

Thanks for reporting. Might be a bug, might be related to customizations, might be a configuration error. Please first read our upgrade guide if you haven't, and if that doesn't help, follow our bug reporting guide which explains everything you need to know.

[do-me]

Related issue #4851.
I have the same problem. The upgrade guide references that something in the search changes, but not what to adapt.

After digging through the changes, I found that something in the header partial changed the block is looking for . Please see here, line 139.

@squidfunk
Please add to your upgrade guide (version jump 8 to 9) what exactly to change in the mkdocs.yml. I suppose the search plugin must be called differently or something is missing?
Tried to fix it by comparing it to mkdocs-material mkdocs.yml itself, but couldn't get it working.

If you need something to reproduce see my Test-Repo and install mkdocs-material 8.5 / 9 each.

[facelessuser]

IIRC, I had this happen as well. If you are overriding header.html, which I was and you seem to as well, I had to edit this:

    <!-- Button to open search modal -->
    {% if "material/search" in config.plugins %}
      <label class="md-header__button md-icon" for="__search">
        {% include ".icons/material/magnify.svg" %}
      </label>

      <!-- Search interface -->
      {% include "partials/search.html" %}
    {% endif %}

Specifically, it should be noted that prior to the recent release you had to look for search in the plugins, now it requires material/search. Hope that helps.

[facelessuser]

@squidfunk , this should be documented as I imagine others will run into this as well.

[do-me]

That's it @facelessuser! Thanks a lot.
@squidfunk could you mark this as the answer for others? I guess the upgrade guide would be the right place to add a note about changing partials.

[squidfunk]

Ah, thanks, yeah, that's likely the thing everybody is tripping over. We've had this change for so long in Insiders, it didn't came to my mind that this might be the cause. I'll add something to the upgrade guide.

[squidfunk]

Added in 88cfdce. The upgrade guide now includes:

[SoumayaMauthoorMOJ]

Had the same problem! @squidfunk Can I suggest you update https://github.com/squidfunk/mkdocs-material/blob/master/docs/setup/setting-up-site-search.md to:

plugins:
  - material/search

[squidfunk]

Thanks @SoumayaMauthoorMOJ. This is unnecessary – you can and should just configure it as search. It is only necessary if you have a second third-party plugin (not MkDocs own search plugin) installed that is also called search.

[SoumayaMauthoorMOJ]

Understood @squidfunk 👍 Perhaps it should be included in https://squidfunk.github.io/mkdocs-material/customization? https://ministryofjustice.github.io/analytical-platform-data-engineering/ uses a theme that I have customised from mkdocs material (https://github.com/ministryofjustice/mkdocs-tech-docs-template) . I had to set the plugin to material\search in order for the search bar to appear, even though I don't think I have installed a second third-party plugin.