List for cgit developers and users
 help / color / mirror / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: cgit@lists.zx2c4.com
Subject: [PATCH 2/2] index: avoid formatting issue in git clone instructions
Date: Wed, 16 Feb 2022 01:07:58 -0500	[thread overview]
Message-ID: <20220216060758.949317-3-tmz@pobox.com> (raw)
In-Reply-To: <20220216060758.949317-1-tmz@pobox.com>

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@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


  parent reply	other threads:[~2022-02-16  6:08 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-16  6:07 [PATCH 0/2] wiki: update some links and fix some formatting Todd Zullinger
2022-02-16  6:07 ` [PATCH 1/2] update Fedora & OS X package links, add OpenBSD Todd Zullinger
2022-02-16  6:07 ` Todd Zullinger [this message]
2023-02-04 22:25 ` [PATCH 0/2] wiki: update some links and fix some formatting Todd Zullinger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220216060758.949317-3-tmz@pobox.com \
    --to=tmz@pobox.com \
    --cc=cgit@lists.zx2c4.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).