Search results encode `&` as `&`

[kendralockard]

Context

No response

Bug description

When searching for terms that contain an ampersand (&), MkDocs search results display & instead of &.

This occurs both on my company documentation site that uses MkDocs, as well as on the official MkDocs documentation site itself (https://squidfunk.github.io/mkdocs-material/).

Example (here):

Related links

Similar issues have been opened and closed in the past, but the problem persists.

• search does not support utf8 #2970
• Search highlighting does not properly escape HTML #2879
• Possibly related: Search do not support utf8 first character #271

Reproduction

I tried but cannot reproduce this bug in a minimal site locally. But, it happens on https://squidfunk.github.io/mkdocs-material/ and our production site.

Steps to reproduce

1. Open https://squidfunk.github.io/mkdocs-material/ in a browser.
2. Use the search bar to search for a phrase with an ampersand, e.g., Your knowledge & skills.
3. All ampersands are shown as &.

Browser

Safari, Firefox

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 using the built-in info plugin.

[squidfunk]

Thanks for reporting. Fixed in ee67845.

[kendralockard]

Hi @squidfunk , thanks for taking a look at this issue! I went to https://squidfunk.github.io/mkdocs-material/ and am still experiencing the same issue.

It appears that this is more general than & and that other utf8 characters, such as ' are not being properly escaped either.

Screenshot:

[squidfunk]

Thanks for reporting back. I haven't yet merged things through to Insiders, and the changes are not yet released, so that's expected. I've now done the Insiders merge (which is what we build our documentation with), so it works now.

It appears that this is more general than & and that other utf8 characters, such as ' are not being properly escaped either.

If you can provide a reproduction I can look into this, but without one, I'm not able to help. Please also first check if the issue is gone now in our documentation, and if not, a minimal reproduction is mandatory, as demanded by our bug reporting process.

[kendralockard]

Got it, thanks! It appears to be working for me as well now after the Insiders merge.

If you can provide a reproduction I can look into this, but without one, I'm not able to help. Please also first check if the issue is gone now in our documentation, and if not, a minimal reproduction is mandatory, as demanded by our bug reporting process.

I understand, and I tried to reproduce this locally but was unable to for some reason. But I thought it best to report anyways since it was occurring on both of our production sites. In any case, it appears to be resolved now. Thanks so much!