Improve the UX of README command codeblocks #698
Merged
Conversation
This file contains 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
edmorley
added
documentation
* Removes the leading terminal prompt `$` from single command codeblocks, so that GitHub's "copy to clipboard" feature can be used to copy the commands directly into the terminal. * Switches multi-line "command plus example output" codeblocks from language `shell` to `console` to prevent broken syntax highlighting (e.g. the "test" in "To test your buildpack" was being highlighted as a bash script, not console output).
edmorley
force-pushed
the
edmorley/codeblock-ux
branch
from
4cf943c to
b48cd62
Compare
Malax
approved these changes
Oct 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
$from single command codeblocks, so that GitHub's "copy to clipboard" feature can be used to copy the commands directly into the terminal.shelltoconsoleto prevent broken syntax highlighting (e.g. the "test" in "To test your buildpack" was being highlighted as a bash script, not console output).GUS-W-14320799.