Skip to content

Conversation

@basnijholt
Copy link
Owner

Summary

  • The docs site renderer (Zensical/pymdownx) doesn't understand code fence language identifiers like python markdown-code-runner
  • This caused fenced code blocks to be parsed incorrectly, breaking the Examples page rendering
  • Added a regex transformation to strip the markdown-code-runner modifier when pulling content from README

Test plan

  • Verified docs build successfully with uv run zensical build
  • Verified code blocks now render with proper syntax highlighting
  • CI should pass and Examples page should render correctly

The docs site renderer (Zensical/pymdownx) doesn't understand the
"python markdown-code-runner" syntax for code fence language identifiers.
This causes the fenced code blocks to be parsed as inline code instead
of proper code blocks, breaking the rendering.

Add a regex transformation in _transform_readme_links() to strip the
"markdown-code-runner" modifier when pulling content from README into
the docs templates.
@basnijholt basnijholt merged commit 46922c1 into main Jan 14, 2026
14 checks passed
@basnijholt basnijholt deleted the fix-code-fence-rendering branch January 14, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants