Skip to content

Commit ac39688

Browse files
committed
_includes/cli.md: fix flag descriptions with < and >
Some flag descriptions contain point-brackets to indicate required options, e.g.: --ssh stringArray SSH agent socket or keys to expose to the build (format: default|<id>[=<socket>|<key>[,<key>]]) When rendering those options as HTML, those options were not visible as they were rendered as a HTML element. Given that flag-descriptions are not expected to have MarkDown or HTML formatting, we can HTML-escape them to prevent this. This patch escapes the flag-descriptions using liquid's `esacape` command. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 3aa6f39 commit ac39688

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

_includes/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ For example uses of this command, refer to the [examples section](#examples) bel
126126
<tr>
127127
<td markdown="span">`--{{ option.option }}{% if option.shorthand %} , -{{ option.shorthand }}{% endif %}`</td>
128128
<td markdown="span">{{ option-default }}</td>
129-
<td markdown="span">{% if all-badges != '' %}{{ all-badges | strip }}<br />{% endif %}{{ option.description | strip }}</td>
129+
<td markdown="span">{% if all-badges != '' %}{{ all-badges | strip }}<br />{% endif %}{{ option.description | strip | escape }}</td>
130130
</tr>
131131
{% endfor %} <!-- end for option -->
132132
</tbody>

0 commit comments

Comments
 (0)