Skip to content

Fix rendering of text in angle brackets in README.md

Doug Ilijev via GitGitGadget git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest1 patch 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/1README: fix rendering of text in angle bracketsREADME.md+1 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/1] Fix rendering of text in angle brackets in README.md

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.

Doug Ilijev (1):
README: fix rendering of text in angle brackets

 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

base-commit: 9d418600f4d10dcbbfb0b5fdbc71d509e03ba719
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-289%2Fdilijev%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-289/dilijev/patch-1-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/289

Signature · 1 line
gitgitgadget