git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
DGDoug Ilijev via GitGitGadget <gitgitgadget@gmail.com>
Date
Jul 18, 2019, 19:08 UTC
Message-ID
<439190dd3a24ac4c9d6300e68cc15c45e3d0fea8.1563476924.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.289.git.gitgitgadget@gmail.com>
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 --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
-- 
gitgitgadget
Previous: Doug Ilijev via GitGitGadgetNext: Jeff King
Message 2 of 3 in “Fix rendering of text in angle brackets in README.md”
  1. 0/1 Fix rendering of text in angle brackets in README.mdDoug Ilijev via GitGitGadget, Jul 18, 2019
  2. 1/1 README: fix rendering of text in angle bracketsDoug Ilijev via GitGitGadget, Jul 18, 2019
  3. Jeff KingJul 18, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.