Fix rendering of text in angle brackets in README.md
cover 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
PATCH 1/1 README: fix rendering of text in angle brackets
From: Doug Ilijev <[email protected]>
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.
--- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
README.md +1 -1
@@ -19,7 +19,7 @@ including full documentation and Git related tools. See [Documentation/gittutorial.txt][] to get started, then see [Documentation/giteveryday.txt][] for a useful minimum set of commands, and -Documentation/git-<commandname>.txt for documentation of each command. +`Documentation/git-<commandname>.txt` for documentation of each command. If git has been correctly installed, then the tutorial can also be read with `man gittutorial` or `git help tutorial`, and the documentation of each command with `man git-<commandname>` or `git help
Signature · 1 line
gitgitgadget
Quoted 7 lines · Doug Ilijev via GitGitGadget
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.
Yeah, I think backticks are the best solution; they match what we do later in that same paragraph.
This kind of "an alternative..." explanation would go very well in the actual commit message, too. :) Other than that nit, the patch looks good to me.
-Peff