8000 Tags with multiple words not showing up in search · Issue #4004 · squidfunk/mkdocs-material · GitHub
[go: up one dir, main page]

Skip to content

Tags with multiple words not showing up in search #4004

@todd-tech-writer

Description

@todd-tech-writer

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 I add a tag with multiple words in it on one of my markdown pages, the page does not show up when searching for the tag.

Expected behaviour

I'd expect when searching for a multiple-word tag on my website, for the page with the tag to appear at the top of the search results.

Actual behaviour

I added the tags Correct Tag and Find Me to test-file.md. When I search for the tag Find Me in the search bar of my website, the test-file.md page is not shown in the search results. When I only type Find in the search bar, it will populate. See the screenshots below for an example:

image

image

image

Steps to reproduce

  1. Create a simple mkdocs.yml with tags and metadata
  2. Create a tag on test-file.md called Find Me
  3. Run mkdocs serve
  4. Search for Find Me

Package versions

  • Python: 3.8
  • MkDocs: 1.3.0
  • Material: 8.2.8

Configuration

site_name: 'Test Site'
site_description: 'Description'
site_author: 'Company'

nav:
  - Home:
    - Introduction: index.md
    - Getting Started: test-file.md

theme:
  name: 'material'

markdown_extensions:
  - meta

plugins:
  - search
  - tags

System information

  • Operating system: macOS Monterey 12.4
  • Browser: Chrome

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssue reports a bugresolvedIssue is resolved, yet unreleased if open

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0