fix: add markdown extensions for PDF tab rendering - #231
Open
jackgdsf wants to merge 1 commit into
Open
Conversation
Add pymdownx.tabbed, pymdownx.superfences, and admonition so content tabs and warning blocks render correctly in the release PDF. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jackgdsf
requested review from
MarkCunningham0410,
cdaunt,
das-dias,
joamatab,
kevinwguan and
thanojo
as code owners
July 28, 2026 00:19
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideConfigures MkDocs PDF build to properly render tabbed content and admonition blocks by enabling the corresponding markdown extensions in mkdocs-pdf.yml. Flow diagram for MkDocs PDF build with new markdown extensionsflowchart TD
A[MkDocs PDF build
mkdocs build -f mkdocs-pdf.yml] --> B[Load mkdocs-pdf.yml]
B --> C[Enable markdown_extensions]
C --> C1[pymdownx.tabbed
alternate_style true]
C --> C2[pymdownx.superfences]
C --> C3[admonition]
C1 --> D[Render markdown
with tabs]
C2 --> D
C3 --> E[Render markdown
with admonitions]
D --> F[Generate PDF
with rendered tabs]
E --> F
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- To avoid the PDF build rendering differently from the main site, consider mirroring the full
markdown_extensionsconfiguration from your primarymkdocs.yml(not just the three newly added ones) so both builds stay in sync.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- To avoid the PDF build rendering differently from the main site, consider mirroring the full `markdown_extensions` configuration from your primary `mkdocs.yml` (not just the three newly added ones) so both builds stay in sync.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
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
Add
pymdownx.tabbed,pymdownx.superfences, andadmonitionmarkdown extensions tomkdocs-pdf.ymlso content tabs and warning blocks render correctly in the release PDF.Without these extensions, the PDF shows literal tab syntax and raw admonition markup instead of rendered content.
Same fix as doplaydo/tps45#296.
Changes
mkdocs-pdf.yml: Addmarkdown_extensionssectionTest plan
mkdocs build -f mkdocs-pdf.ymlsucceedsCloses #230
Summary by Sourcery
Build: