This repository was archived by the owner on Nov 21, 2025. It is now read-only.
fix rendering for both jekyll and github#67
Open
hchiam wants to merge 3 commits intogoogle:masterfrom
Open
Conversation
…ll and github (copy what is done in cl-descriptions)
…backticks like how cl-descriptions has it already rendering correctly in both)
Author
|
basically:
|
Author
|
anyone free to review this? |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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:
