Ampersands seen in search results #3213
Comments
|
It looks like this is the offending line. I'm new here, so I don't know the ins and outs of the program. I was able to replicate the problem by adding an ampersand to a title of a markdown document. I don't know if removing the I see that the search result is getting formatted as if it's getting inserted directly into HTML with escapes, but is the |
|
#3560 is an attempted fix but it's also rather confusing. Instead maybe this simpler fix could be applied. diff --git a/mkdocs/contrib/search/search_index.py b/mkdocs/contrib/search/search_index.py
index 770f24fe2..c90eeb0dc 100644
--- a/mkdocs/contrib/search/search_index.py
+++ b/mkdocs/contrib/search/search_index.py
@@ -8,6 +8,8 @@ import subprocess
from html.parser import HTMLParser
from typing import TYPE_CHECKING
+from markupsafe import Markup
+
if TYPE_CHECKING:
from mkdocs.structure.pages import Page
from mkdocs.structure.toc import AnchorLink, TableOfContents
@@ -90,7 +92,9 @@ class SearchIndex:
text = ' '.join(section.text) if self.config['indexing'] == 'full' else ''
if toc_item is not None:
- self._add_entry(title=toc_item.title, text=text, loc=abs_url + toc_item.url)
+ self._add_entry(
+ title=Markup(toc_item.title).striptags(), text=text, loc=abs_url + toc_item.url
+ )
def generate_search_index(self) -> str:
"""Python to json conversion."""This fixes escaping in the search index and causes no other changes for MkDocs' own site at least - "title": "<script> tags can specify type=\"module\" and other attributes"
+ "title": "<script> tags can specify type=\"module\" and other attributes" |
|
And how does this proposal address the issues raised in the first comment on #3560? |
|
I don't know what exact issue the rest of #3560 is supposed to address, to be honest. It makes several changes in behavior and claims that they are for the better but I don't think I agree that it's better. |
|
|
|
What are we here for if not for the content (& lols?) |
pawamoy
added
Navigation
Table of contents
Titles
Search
and removed
Navigation
Table of contents
labels
I do not own this site. All I know is I did a search and I saw these raw ampersands in the results.
The site was https://vespucci.io/ and the search was for "copy".
At the bottom of the page there's indication that it was using your software package. Hence I'm reporting the problem directly to you, in the hope that future editions of the software will avoid the problem.
The text was updated successfully, but these errors were encountered: