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

file/folder names with spaces break tag listings #8016

Closed
4 tasks done
bj-s opened this issue Feb 18, 2025 · 2 comments
Closed
4 tasks done

file/folder names with spaces break tag listings #8016

bj-s opened this issue Feb 18, 2025 · 2 comments
Labels
bug Issue reports a bug 🏆 perfect Issue is of outstanding quality resolved Issue is resolved, yet unreleased if open

Comments

@bj-s
Copy link

bj-s commented Feb 18, 2025

Context

Built-in tags plugin

Bug description

When a file with an inline listing (or any of its parent folders) contains a space in its name, the listing fails silently. Instead of a listing e.g. the following is rendered:

"tags filename with spaces.md:29-51/name"

<h6 filename="filename" id="tags" spaces.md:29-51_slug="spaces.md:29-51/slug" with="with">
    tags filename with spaces.md:29-51/name
</h6>

Related links

Reproduction

9.6.4-filefolder-names-with-spaces-break-tag-listings.zip

Steps to reproduce

  1. Build mkdocs build --verbose
  2. No Warning, Exception or Debug print thrown
  3. open site/tags filename with spaces/index.html (for a file name with spaces) or site/test folder/tags_file/index.html (for a folder name with spaces)
  4. you can see the issue
  5. site/tags_file/index.html shows that tags work when the file name does not contain spaces

Browser

No response

Before submitting

@squidfunk
Copy link
Owner

Thanks for reporting! Fixed in 3a11e3e. Thanks to the reproduction, I was able to fix this in 5 minutes. This is a perfect issue, as it contains a precise reproduction, is not wordy but very much to the point, and is thus a perfect starting ground for us to investigate and fix the problem.

@squidfunk squidfunk added bug Issue reports a bug resolved Issue is resolved, yet unreleased if open 🏆 perfect Issue is of outstanding quality labels Feb 19, 2025
@squidfunk
Copy link
Owner

Released as part of 9.6.5.

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

No branches or pull requests

2 participants