Improve markdown for crane code snippets #2091
Open
Conversation
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
Before this change, code snippets in the README were hard to copy since they contained a leading `$ ` and mixed shell commands with console output. This change aims to improve the syntax so pure shell code snippets are easier to copy and so console output is marked as such (so GitHub can properly distinguish between command and output when rendering it). Also adds correct code fence for a YAML snippet.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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.
Before this change, code snippets in the README were hard to copy since they contained a leading
$and mixed shell commands with console output. This change aims to improve the syntax so pure shell code snippets are easier to copy and so console output is marked as such (so GitHub can properly distinguish between command and output when rendering it). Also adds correct code fence for a YAML snippet.