Instant loading: returning to index page breaks search and other features

[sarcastro]

Context

No response

Bug description

Search is not functional from the index page when navigation.instant is enabled except for when first loaded.

Refreshing page restores functionality.

Note: issue does not appear to be limited to search as page no longer refreshes automatically when using mkdocs serve either.

Related links

• Reporting a bug
• Creating a reproduction
• Setting up navigation
• Setting up navigation: Instant loading
  • "Now, the search index survives navigation..." – issue appears to contradict this

Reproduction

9.4.7-navigation-instant-index.zip

Steps to reproduce

1. Navigate away from index page (e.g. by following a link)
2. Return to index page (e.g. using left navigation menu)
3. Try to search (no longer functional)

Note: steps to reproduce are included in the reproduction as well.

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction.

[squidfunk]

Thanks for reporting! I think this should be fixed with 494cae1!

[sarcastro]

Thanks for reporting! I think this should be fixed with 494cae1!

Fantastic, much appreciated! I'll let you know the verdict

[squidfunk]

Released as part of 9.4.8.

[sarcastro]

Released as part of 9.4.8.

Didn't seem to make a difference, unfortunately. Here's a new reproduction with the same configuration and steps to reproduce as before.

9.4.8-navigation-instant-index-2.zip

[sarcastro]

@squidfunk - should I create a duplicate report?

[squidfunk]

No, I'll look into it once I find some time. Sorry, I've had this in my inbox but I'm currently busy with #6307.

[squidfunk]

Fixed in https://github.com/squidfunk/mkdocs-material-insiders/pull/79 – the fixes are currently only in Insiders, so anybody having access can already test them. I still need to do some minor refactoring that shouldn't impact the functionality, and after that, I'll backport the fixes to the community edition. I just wanted to give them into the hands of users as soon as possible. This should resolve all known problems with instant loading, at least I've tested this and all other issues.

[squidfunk]

Fixes are now in #6662. Please check if the errors are now fixed when using this version in your project:

pip install git+https://github.com/squidfunk/mkdocs-material.git@fix/instant-loading-bugs

[squidfunk]

Released as part of 9.5.5.