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

search does not support utf8 #2970

Closed
4 of 5 tasks
antoinekh opened this issue Aug 24, 2021 · 4 comments
Closed
4 of 5 tasks

search does not support utf8 #2970

antoinekh opened this issue Aug 24, 2021 · 4 comments
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open

Comments

@antoinekh
Copy link

Contribution guidelines

I've found a bug and checked that ...

  • ... the problem doesn't occur with the mkdocs or readthedocs themes
  • ... the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • ... the documentation does not mention anything about my problem
  • ... there are no open or closed issues that are related to my problem

Description

When using the search, utf-8 special characters are not displayed correctly.
This only happens in the display of the different search responses.
I don't have this feature with RTD

For exemple a search for "Source & Destination"

This happens for all utf8 encoded characters.

Example of a text with the problem:


### Source & Destination

![Capture exemple sources](img/02_exemples_sources.png){ align=right }

Elles peuvent etre dans plusieurs formats:

* IP
* Subnet/masque
* Range IP: IP1-IP2
* FQDN
* Objects depuis un firewall


Expected behaviour

The quick search displays "Source & Destination".

Actual behaviour

image

Steps to reproduce

  1. Create page with some utf8 text: ' &
  2. search for this text

Package versions

  • Python: python --version 3.6.9
  • MkDocs: mkdocs --version 1.2.2
  • Material: pip show mkdocs-material | grep -E ^Version Version: 7.2.0

Configuration

site_name: Documentation Tufin
site_url: ****

theme:
  name: material
  features:
    - navigation.top
    - navigation.tabs
    - search.highlight
    - search.suggest
    - search.share
  plugins:
    - search
  language: fr
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
markdown_extensions:
  - attr_list
  - admonition

System information

  • Operating system: W10
  • Browser: Chrome and Firefox
@squidfunk
Copy link
Owner

Thanks for reporting. Regression due to #2879

@squidfunk squidfunk added the bug Issue reports a bug label Aug 24, 2021
@squidfunk
Copy link
Owner

Fixed in 829820a.

@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Aug 24, 2021
@squidfunk
Copy link
Owner

Released as part of 7.2.5.

@antoinekh
Copy link
Author

I confirm that it is ok, thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

2 participants