-
Notifications
You must be signed in to change notification settings - Fork 123
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
Support horizontal layout in code and output boilerplates #2194
Support horizontal layout in code and output boilerplates #2194
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good find & fix @yucheng11122017!
The changes look good to me, and I couldn't find any related issues / PRs for why we were using the arrows instead of the boilerplate, so LGTM :)
Great work with the PR! I think this is good for the user guide as it creates consistency when reading it! LGTM! |
Thank you @yucheng11122017 for raising this. My suggestion as seen in that issue:
Regarding the specific issue of formatting in this PR, I think the first code example For a start, I think it would be good to create a nunjucks boilerplate that simplifies the creation of code-and-output-horizontal style code blocks. This is for our internal usage in our docs (or if it works well, we can add instructions on how to do so in our user guide). Then if you are interested, we can look at making this feature more accessible via a plugin or a standalone component. What do you think? |
Hi @tlylt thanks for your comments. Eg.
Is that ok? If yes, I will proceed to modify the other |
Sure go ahead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
What is the purpose of this pull request?
Contributes to #572
Overview of changes:
Standardize usage of codeAndOutput.md boilerplate in UG
Change boilerplate for
codeAndOutput.md
,codeAndOutputCode.md
andcodeAndOutputSeperate.md
to allow horizontal layout.Before:
After:
Anything you'd like to highlight/discuss:
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Support horizontal layout in code and output boilerplates
Checklist: ☑️