You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Python Markdown abbreviations plugin (abbr) is not functioning correctly when used with Material for MkDocs.
Abbreviations are being rendered as plain text instead of creating the expected HTML abbreviation elements with tooltips.
@leviofanh Downloaded and tested and turns out you had a false space before markdown-extensions: (not sure how they're called)
Wrong:
Right:
What i mean is there were 2 empty spaces before markdown-extensions: essentially putting it under theme:
markdown extensions need their own line, delete the 2 spaces and it works. Nothing faulty about the plugin, it was human error
If you're using VS Code there is a YAML extension that will show you the faults.
The [HTML]: HyperText Markup Language is the text that shows up
*[HTML]: HyperText Markup Language is essentially the "tooltip"
So the use case for it would be:
When hovering over the [HTML] tag you should see a tooltip.
*[HTML]: I am the tooltip
Context
Environment
Bug description
The Python Markdown abbreviations plugin (
abbr
) is not functioning correctly when used with Material for MkDocs.Abbreviations are being rendered as plain text instead of creating the expected HTML abbreviation elements with tooltips.
Related links
Reporting a bug
The abbreviations extension is properly configured in
mkdocs.yml
and should work according to the:Material for MkDocs documentation
and
Python Markdown documentation
Reproduction
9.5.49-abbreviations-plugin-not-working.zip
Steps to reproduce
test.md
)mkdocs.yml
with the following settings:mkdocs serve
Expected Behavior
When hovering over the "HTML" text, a tooltip should appear showing "HyperText Markup Language".
Actual Behavior
The abbreviation syntax
[HTML]: HyperText Markup Language
is rendered as plain text without creating the expected tooltip functionality.Browser
No response
Before submitting
The text was updated successfully, but these errors were encountered: