Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add built-in search plugin to config example #14

Merged
merged 1 commit into from
Sep 18, 2023

Conversation

infotexture
Copy link
Contributor

When I copied the config example here, the search box disappeared from my output.

After a bit of research, I found this in the Material theme docs:

The built-in search plugin integrates seamlessly with Material for MkDocs, adding multilingual client-side search with lunr and lunr-languages. It's enabled by default, but must be re-added to mkdocs.yml when other plugins are used

To prevent confusion, I've added that line to the config example.

When I copied the config example here, the search box disappeared from my output.

After a bit of research, I found this in the [Material theme docs](https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin):

> The built-in search plugin integrates seamlessly with Material for MkDocs, adding multilingual client-side search with lunr and lunr-languages. It's enabled by default, but must be re-added to `mkdocs.yml` when other plugins are used

To prevent confusion, I've added that line to the config example.
@oprypin oprypin merged commit c5bafa5 into oprypin:master Sep 18, 2023
@infotexture infotexture deleted the patch-1 branch September 19, 2023 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants