Skip to content

Fix rendering of text in angle brackets in README.md#289

Closed
dilijev wants to merge 1 commit intogitgitgadget:masterfrom
dilijev:patch-1
Closed

Fix rendering of text in angle brackets in README.md#289
dilijev wants to merge 1 commit intogitgitgadget:masterfrom
dilijev:patch-1

Conversation

@dilijev
Copy link

@dilijev dilijev commented Jul 18, 2019

Markdown incorrectly interpreted <commandname> as an HTML tag;
use backticks to escape Documentation/git-<commandname>.txt to ensure
that it renders the text as intended.

An alternative would be to HTML-escape the angle-brackets,
at the cost of readability of the markdown in plaintext form.
I opted for the backticks to preserve plaintext readability.

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants