Skip to content

fix rendering for both jekyll and github #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

hchiam
Copy link

@hchiam hchiam commented Mar 27, 2025

fix #64 (good and bad example rendering correctly for github but not for jekyll)
fix #66 (table rendering badly for both github and jekyll)

for screenshots of proof that the suggested fixes are guaranteed to work for both jekyll and github, see the comment at #66 (comment):
it mentions website cl-descriptions.html and github view of cl-descriptions.md

for convenience, you can see the raw code for cl-descriptions uses "``` {.good}" at https://raw.githubusercontent.com/google/eng-practices/refs/heads/master/review/developer/cl-descriptions.md

and here's what the table looks like now when the raw md code is viewed within vscode:
Screen Shot of table markdown with backticks before and after

@hchiam
Copy link
Author

hchiam commented Mar 27, 2025

basically:

what renders correctly for jekyll renders correctly for github
cl-descriptions YES YES
handling-comments no (#64 (comment)) YES
small-cls no (#66 (comment)) no (#66 (comment))

Copy link
Author

@hchiam hchiam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready for review.

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.

table rendering badly in both jekyll output and in github Bad rendering text on webpage
1 participant