mkdocs: Search in 0.17.0 is incompatible with third-party themes
Firstly, congratulations on version 0.17. Really nice to see MkDocs is evolving. I read about the new plugin system and tried to upgrade to MkDocs 0.17. I also added this to my mkdocs.yml:
plugins:
- search
However, the index doesn’t seem to be generated and MkDocs is complaining about a search.html not being present. Material defines the search.html as a partial, as it’s part of the main theme.
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Template skipped: 'search.html'. Not found in template directories.
[I 171020 09:30:09 server:283] Serving on http://127.0.0.1:8000
[I 171020 09:30:09 handlers:60] Start watching changes
[I 171020 09:30:09 handlers:62] Start detecting changes
[I 171020 09:30:28 handlers:133] Browser Connected: http://localhost:8000/
[W 171020 09:30:29 web:2063] 404 GET /mkdocs/search_index.json (127.0.0.1) 1.79ms
Any directions?
About this issue
- Original URL
- State: closed
- Created 7 years ago
- Comments: 24 (23 by maintainers)
Commits related to this issue
- Search page needs to be included to allow showing 'all results' Also include search settings into instructions for using custom_dir, since theme's mkdocs_theme.yml is ignored in that case (see https:... — committed to gristlabs/mkdocs-windmill by dsagal 6 years ago
- Include search.html page and update documentation and example. The search page needs to be included to allow showing 'all results'. In documentation, what used to be 'theme_dir' is now 'theme.custom... — committed to gristlabs/mkdocs-windmill by dsagal 6 years ago
Fixed in #1322.
I expect 0.17.1 will be out before next week. There are a couple other possible issues, but they seem very minor.
Unfortunately, I ran out of time on Friday. I’m guessing Monday or Tuesday.