Fix README tile rendering by displaying example image instead of unstyled HTML #24
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.
The README.Rmd file was generating Bootstrap-styled HTML that appeared broken on GitHub because GitHub's markdown renderer doesn't support external CSS styling. This caused the tiles to display as plain unstyled HTML instead of the intended formatted dashboard tiles.
Root Cause:
GitHub strips external CSS links and doesn't load Bootstrap, so the generated HTML with Bootstrap classes (like
panel
,container
,btn-*
) renders without any styling, appearing as plain text instead of formatted tiles.Solution:
example.PNG
image instead of generating live HTMLeval=FALSE
to the code block to show the code example without executing thefinisher()
functionBefore: README showed unstyled HTML that looked broken
After: README shows the proper tile visualization via image, with code example for reference
This ensures users see what TileMaker actually produces when properly styled, while maintaining the educational value of the code sample. The pkgdown site continues to work correctly since it has proper CSS support.
Fixes #23.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.