[gh config][website manual] Escape pipe symbols in long description#10688
Closed
[gh config][website manual] Escape pipe symbols in long description#10688
Conversation
cliAutomation
added
the
external
iamazeem
changed the title
Member
|
Thanks for the PR, @iamazeem! 🙏 I put some time to investigate this, and as you said, the last fix has had side effects. Here are the instances I have found:
Among these, I believe the So, I agree with reverting the last change, but I don't think it's a good idea to single out For now, I'll close this PR since I think we a need a little discussion with the team on the issue. I'm going to recap what's going on and suggest a solution, and then wait for folks to comment their thoughts. |
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
3 participants
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.
Fixes #10678.
This PR is an improvement on #10371.
This escapes the pipe symbols for the
gh configcommand only.The existing solution escapes pipe symbols for all the commands which has side effects in addition to what has been reported in #10678.
This is an issue with
kramdownand others have been facing it too.Here in this SO thread, replacing the kramdown parser has been suggested in this answer.
Not sure how much control
jekyllprovides and whether it's doable or not.It would be good to look into to avoid such workarounds in the future given that some other parser works fine.