diff mbox series

[1/1] README: fix rendering of text in angle brackets

Message ID 439190dd3a24ac4c9d6300e68cc15c45e3d0fea8.1563476924.git.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series Fix rendering of text in angle brackets in README.md | expand

Commit Message

Linus Arver via GitGitGadget July 18, 2019, 7:08 p.m. UTC 
From: Doug Ilijev <doug.ilijev@gmail.com>

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.

Signed-off-by: Doug Ilijev <doug.ilijev@gmail.com>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/README.md b/README.md
index 88f126184c..e1d2b82209 100644
--- a/README.md
+++ b/README.md
@@ -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