[PATCH 2/2] index: avoid formatting issue in git clone instructions
Todd Zullinger
tmz at pobox.com
Wed Feb 16 06:07:58 UTC 2022
The bulleted list which includes instructions for cloning cgit are
intended to be formatted as:
* clone the repo:
* git clone https://git.zx2c4.com/cgit
with the git clone command being a nested list. This does not work with
markdown-python and instead is rendered as two separate bullet points.
According to upstream¹:
Python-Markdown consistently requires 4 spaces of indent per level
or it ignores the indent
While we could adjust the indent level, it seems cleaner to simply
remove the nested list item for the git clone command and format it as
code.
¹ https://github.com/Python-Markdown/markdown/issues/125#issuecomment-7210925
Signed-off-by: Todd Zullinger <tmz at pobox.com>
---
index | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/index b/index
index 048ab05..2570c42 100644
--- a/index
+++ b/index
@@ -35,8 +35,7 @@ Features
Source Code
-----------
* download current or past [releases][]
- * clone the repo:
- * git clone https://git.zx2c4.com/cgit
+ * clone the repo: `git clone https://git.zx2c4.com/cgit`
* see the [README][] for build instructions
[releases]: /cgit/refs/tags
--
2.35.1
More information about the CGit
mailing list