Skip to content

Commit b21aefd

Browse files
committedFeb 24, 2025
fix: Only preserve tags in titles if Material for MkDocs' content.tooltips feature is enabled
1 parent b653e01 commit b21aefd

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ plugins:
202202

203203
[instant-preview]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-previews
204204

205-
By default, HTML tags are only preserved in titles if the current theme in use in Material for MkDocs. If the theme you are using does support HTML tags titles, you can prevent tags stripping with the `strip_title_tags` option:
205+
By default, HTML tags are only preserved in titles if the current theme in use is Material for MkDocs and its `content.tooltips` feature is enabled. If your chosen theme does support HTML tags in titles, you can prevent tags stripping with the `strip_title_tags` option:
206206

207207
```yaml
208208
plugins:

‎src/mkdocs_autorefs/_internal/plugin.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,10 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
189189
self._link_titles = self.config.link_titles
190190

191191
if self.config.strip_title_tags == "auto":
192-
if getattr(config.theme, "name", None) == "material":
192+
if getattr(config.theme, "name", None) == "material" and "content.tooltips" in config.theme.get(
193+
"features",
194+
(),
195+
):
193196
self._strip_title_tags = False
194197
else:
195198
self._strip_title_tags = True

‎tests/test_plugin.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def test_auto_strip_title_tags_false() -> None:
183183
plugin.config = AutorefsConfig()
184184
plugin.config.strip_title_tags = "auto"
185185
config = MkDocsConfig()
186-
config.theme = Theme(name="material")
186+
config.theme = Theme(name="material", features=["content.tooltips"])
187187
plugin.on_config(config=config)
188188
assert plugin._strip_title_tags is False
189189

@@ -195,6 +195,10 @@ def test_auto_strip_title_tags_true() -> None:
195195
plugin.config.strip_title_tags = "auto"
196196
config = MkDocsConfig()
197197

198+
config.theme = Theme(name="material", features=[])
199+
plugin.on_config(config=config)
200+
assert plugin._strip_title_tags is True
201+
198202
config.theme = Theme("mkdocs")
199203
plugin.on_config(config=config)
200204
assert plugin._strip_title_tags is True

0 commit comments

Comments
 (0)
Please sign in to comment.