Fix docs syntax highlighting in admonition code blocks#10346
Merged
Fix docs syntax highlighting in admonition code blocks#10346
Conversation
Remove conflicting codehilite extension that was preventing pymdownx.highlight + pymdownx.superfences from properly syntax highlighting code blocks nested inside admonitions.
nopcoder
added
exclude-changelog
Pygments 2.20.0 added html.escape() on the filename parameter in HtmlFormatter but doesn't handle None values. pymdownx.highlight passes filename=None when auto_title is disabled, causing a crash. This surfaced after removing the conflicting codehilite extension.
github-actions
Bot
added
the
dependencies
|
📚 Documentation preview at https://pr-10346.docs-lakefs-preview.io/ (Updated: 4/8/2026, 9:34:13 PM - Commit: e26766c) |
pymdown-extensions 10.21.2 fixes the filename=None crash with Pygments 2.20+ (facelessuser/pymdown-extensions#2864), so no need to pin Pygments to an older version.
itaigilo
approved these changes
Apr 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
codehiliteextension from mkdocs.yml — it was intercepting code blocks beforepymdownx.highlight/pymdownx.superfencescould handle them, preventing syntax highlighting inside admonitions (e.g. "Example: lakeFS with Pandas" on the landing page)pymdown-extensionsfrom 10.20.1 to 10.21.2 to fix afilename=Nonecrash with Pygments 2.20+ (facelessuser/pymdown-extensions#2864)Related Issue
Closes #10347
Test plan
mkdocs buildpasses locally with pymdownx 10.21.2 + Pygments 2.20.0