Wrap Pygments lines with <span> to allow for better styling

facelessuser · facelessuser · commit 97f716600719 · 2025-12-30T22:07:44.000-07:00
Inline was always difficult to get line highlights to span the entire
scrollable code block. By ensuring lines are wrapped with a span, code
can be set to `display: grid` allowing for better line highlights.

This should be a benign change and behaves like the `line_span` option,
just without adding the IDs.
diff --git a/docs/src/markdown/about/changelog.md b/docs/src/markdown/about/changelog.md
@@ -11,6 +11,9 @@ icon: lucide/scroll-text
 
     In addition, Quotes also provides an optional feature to enable specifying callouts/alerts in the style used by
     GitHub and Obsidian.
+-   **NEW**: Highlight: When using Pygments and not using the table format for line numbers, lines are now wrapped in
+    `<span>` tags. This allows for easier and better styling of line highlights. Using `line_spans` will additionally
+    add IDs as they always did.
 
 ## 10.19.1
 
diff --git a/docs/src/scss/extensions/_highlight.scss b/docs/src/scss/extensions/_highlight.scss
@@ -55,7 +55,7 @@
   }
 
   pre > code {
-    outline: none;
+    display: grid;
   }
 
   /* Don't always like code breaking in table cells */
diff --git a/docs/theme/assets/pymdownx-extras/extra-54d451ef87.css b/docs/theme/assets/pymdownx-extras/extra-54d451ef87.css
diff --git a/docs/theme/assets/pymdownx-extras/extra-54d451ef87.css.map b/docs/theme/assets/pymdownx-extras/extra-54d451ef87.css.map
diff --git a/pymdownx/__meta__.py b/pymdownx/__meta__.py
@@ -193,5 +193,5 @@ def parse_version(ver: str) -> Version:
     return Version(major, minor, micro, release, pre, post, dev)
 
 
-__version_info__ = Version(10, 19, 1, "final")
+__version_info__ = Version(10, 20, 0, "final")
 __version__ = __version_info__._get_canonical()
diff --git a/pymdownx/highlight.py b/pymdownx/highlight.py
@@ -229,6 +229,57 @@ def _wrap_tablelinenos(self, inner):
             for t, line in HtmlFormatter._wrap_tablelinenos(self, inner):
                 yield t, self.RE_TABLE_NUMS.sub(r'\1<span></span>', line)
 
+        def _wrap_lines(self, inner):
+            """Wrap lines."""
+
+            for t, line in inner:
+                if t:
+                    yield 1, f'<span>{line}</span>'
+                else:
+                    yield 0, line
+
+        def format_unencoded(self, tokensource, outfile):
+            """
+            The formatting process uses several nested generators; which of
+            them are used is determined by the user's options.
+
+            Each generator should take at least one argument, ``inner``,
+            and wrap the pieces of text generated by this.
+
+            Always yield 2-tuples: (code, text). If "code" is 1, the text
+            is part of the original tokensource being highlighted, if it's
+            0, the text is some piece of wrapping. This makes it possible to
+            use several different wrappers that process the original source
+            linewise, e.g. line number generators.
+            """
+
+            source = self._format_lines(tokensource)
+
+            # As a special case, we wrap line numbers before line highlighting
+            # so the line numbers get wrapped in the highlighting tag.
+            if not self.nowrap and self.linenos == 2:
+                source = self._wrap_inlinelinenos(source)
+
+            if self.hl_lines:
+                source = self._highlight_lines(source)
+
+            if not self.nowrap:
+                if self.lineanchors:
+                    source = self._wrap_lineanchors(source)
+                if self.linespans:
+                    source = self._wrap_linespans(source)
+                elif self.linenos in (0, 2):
+                    source = self._wrap_lines(source)
+                source = self.wrap(source)
+                if self.linenos == 1:
+                    source = self._wrap_tablelinenos(source)
+                source = self._wrap_div(source)
+                if self.full:
+                    source = self._wrap_full(source, outfile)
+
+            for _, piece in source:
+                outfile.write(piece)
+
 
 class Highlight:
     """Highlight class."""
diff --git a/zensical.yml b/zensical.yml
@@ -268,7 +268,7 @@ extra:
 
 extra_css:
   # - https://cdn.jsdelivr.net/npm/katex@0.16.25/dist/katex.min.css
-  - assets/pymdownx-extras/extra-2395056a6a.css
+  - assets/pymdownx-extras/extra-54d451ef87.css
 extra_javascript:
   - assets/pymdownx-extras/extra-loader-Ccztcqfq.js
   - https://cdn.jsdelivr.net/npm/mermaid@11.12.1/dist/mermaid.min.js

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`pre > code {`
`58`		`- outline: none;`
	`58`	`+ display: grid;`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/* Don't always like code breaking in table cells */`