Refactor markdown template #420
Merged
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.
This PR updates the markdown template for the
bashly render :mardown
command. In addition, some adjustments in other areas were required to make the most out of the metadata in bashly.yml.String#sanitize_for_print
was updated to escape backticks. This is used in bashprint
command, and we do not want it to mean "execute this command" but rather "mark this as code", which is rendered nicely in markdown and CLI.String#nl2br
andString#for_markdown
, which is used in the template, for escaping<
and>
.markdown.gtx
template to display all the information it has, in a unified and markdown-native manner.print
lines to usesanitize_for_print
wherever there is a chance that these lines will include backticks - to allow developers to use backticks in help messages (for markdown).