Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Material v7 breaks mkdocs-localsearch

See original GitHub issue

I’ve read the [contribution guidelines][1] and agree with them

I’ve found a bug and checked that …

… the problem doesn’t occur with the default MkDocs template
… the problem is not in any of my customizations (CSS, JS, template)
… the documentation does not mention anything about my problem
… there are no open or closed issues that are related to my problem

Description

See https://github.com/wilhelmer/mkdocs-localsearch/issues/12.

Does not occur with any of the v7 beta versions, only in the release versions.

Steps to reproduce the bug

Create a blank MkDocs project.
Install and set up mkdocs-localsearch as described in the docs.
Build.

Download sample project

Project configuration

site_name: My Docs
theme:
  name: material
  custom_dir: theme
use_directory_urls: false
plugins:
  - search
  - localsearch

System information

OS: macOS
Browser: Firefox and Chrome, latest

Issue Analytics

State:
Created 3 years ago
Comments:10 (10 by maintainers)

Top GitHub Comments

1reaction

squidfunkcommented, Mar 4, 2021

Released with 7.0.4

1reaction

squidfunkcommented, Mar 1, 2021

Well. I’m stupid:

https://github.com/squidfunk/mkdocs-material/blob/9ed181b697537dc71407ab4529e2791cdfbf8b23/src/assets/javascripts/components/search/_/index.ts#L87-L88

I added this because I wanted the search to degrade gracefully (= just hide) when served on file://, forgetting about the localsearch plugin 🤦‍♂️ Fixed in eb35ab94.

Top Results From Across the Web

localsearch broke after update from mkdocs-material-insiders ...

localsearch fails after update from v7 insiders to v8 Insiders https://github.com/squidfunk/mkdocs-material-insiders

Changelog - Material for MkDocs - GitHub Pages

Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja ... is disabled (7.0.0 regression); Fixed localsearch integration (7.0.0 regression) ...

mkdocs-localsearch - PyPI

A MkDocs plugin to replace the native "search" plugin with a search plugin that also works locally (file:// protocol). Only works with the...

mkdocs-material Changelog - PyUp.io

Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja ... Fixed localsearch integration (7.0.0 regression)

Configuration - MkDocs

Project settings are configured by default using a YAML configuration file in the project directory named mkdocs.yml . You can specify another path...