search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
82 stars 61 forks source link

Line highlighting in codeblocks has changed #183

Closed bforbis closed 4 days ago

bforbis commented 2 months ago

I have recently just upgraded mkdocs-techdocs-core from v1.2.3 -> v1.3.5 and have been testing on my documentation smoke test page and noticed a significant change in how codeblock highlighting is visualized using the hl_lines directive.

Version 1.2.3 image

Version ^1.3.3 image

I'm not sure if this was an intentional style change or is a bug, but the new way that line highlighting works is too subtle and easy to miss.

I've done some testing of versions in between and this seems to have been introduced in mkdocs-techdocs-core@v1.3.3, which bumped mkdocs-material to 9.4.14

Looking at the css of the .hll and .highlight CSS class, it looks like the background-color was updated:

Old: background-color: var(--md-code-hl-color) New: background-color: var(--md-code-hl-color--light)

This seems to have been changed in mkdocs-material as reported in https://github.com/squidfunk/mkdocs-material/issues/6017

pwalleni commented 2 months ago

Here too. Please fix. Thanks.

awanlin commented 4 days ago

Closing as this looks to be fixed in the upstream Backstage repo by https://github.com/backstage/backstage/pull/24809