# [PATCH] README: create HTTP/HTTPS links from URLs in Markdown 5 messages from 2017-03-01 to 2017-03-02. Participants: Eric Wong, Jeff King. Thread: https://gitlist.dev/t/45259 ## Eric Wong, 2017-03-01 22:22 Subject: [PATCH] README: create HTTP/HTTPS links from URLs in Markdown Message-ID: <20170301222204.GA5413@whir> URL: https://gitlist.dev/e/20170301222204.GA5413%40whir ``` Markdown supports automatic links by surrounding URLs with angle brackets, as documented in While we're at it, update URLs to avoid redirecting clients for git-scm.com (by using HTTPS) and public-inbox.org (by adding a trailing slash). Signed-off-by: Eric Wong --- I was going to cite some style manuals (MLA, APA, etc), but it seems current versions do not favor angle brackets. However, this remains consistent with the recommendations in RFC 2369 for mail headers. README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c0cd5580e..f17af66a9 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Torvalds with help of a group of hackers around the net. Please read the file [INSTALL][] for installation instructions. -Many Git online resources are accessible from http://git-scm.com/ +Many Git online resources are accessible from including full documentation and Git related tools. See [Documentation/gittutorial.txt][] to get started, then see @@ -33,8 +33,8 @@ requests, comments and patches to git@vger.kernel.org (read [Documentation/SubmittingPatches][] for instructions on patch submission). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. The mailing list archives are -available at https://public-inbox.org/git, -http://marc.info/?l=git and other archival sites. +available at , + and other archival sites. The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing -- EW ``` ## Jeff King, 2017-03-02 07:37 Subject: Re: [PATCH] README: create HTTP/HTTPS links from URLs in Markdown Message-ID: <20170302073708.dxm4p24pt6zlqjuz@sigill.intra.peff.net> URL: https://gitlist.dev/e/20170302073708.dxm4p24pt6zlqjuz%40sigill.intra.peff.net In-Reply-To: <20170302073421.GA2528@whir> ``` On Thu, Mar 02, 2017 at 07:34:21AM +0000, Eric Wong wrote: > Jeff King wrote: > > On Wed, Mar 01, 2017 at 10:22:04PM +0000, Eric Wong wrote: > > > > > Markdown supports automatic links by surrounding URLs with > > > angle brackets, as documented in > > > > > > > One of the joys of markdown is that there are so many variants. A lot of > > them (including GitHub-flavored markdown) will linkify URLs even when > > they're not inside angle brackets. > > > > So I don't mind this patch, but I'm curious what's rendering the > > markdown you're seeing. I'd think online that one would either come > > across the raw text, or the GFM from https://github.com/git/git. > > I was using Gruber's reference implementation from Debian stable > (1.0.1-7). OK. I guess my question more was "why are you doing that?". I'd expect people to find the GFM rendering on GitHub, or just look at the text via "less". But it's not really my business why you would want to do it. :) It's reasonable for us to cater to the common subset of renderers. -Peff ``` ## Eric Wong, 2017-03-02 07:34 Subject: Re: [PATCH] README: create HTTP/HTTPS links from URLs in Markdown Message-ID: <20170302073421.GA2528@whir> URL: https://gitlist.dev/e/20170302073421.GA2528%40whir In-Reply-To: <20170302071810.pbczh3p4w4bnyqzg@sigill.intra.peff.net> ``` Jeff King wrote: > On Wed, Mar 01, 2017 at 10:22:04PM +0000, Eric Wong wrote: > > > Markdown supports automatic links by surrounding URLs with > > angle brackets, as documented in > > > > One of the joys of markdown is that there are so many variants. A lot of > them (including GitHub-flavored markdown) will linkify URLs even when > they're not inside angle brackets. > > So I don't mind this patch, but I'm curious what's rendering the > markdown you're seeing. I'd think online that one would either come > across the raw text, or the GFM from https://github.com/git/git. I was using Gruber's reference implementation from Debian stable (1.0.1-7). Also, pandoc (also Debian stable 1.12.4.2~dfsg-1+b14) seems to require angle brackets by default. pandoc also supports the "-f markdown_github" option where it seems to behave like GFM. But yeah, I much prefer the unambiguity of angle brackets, especially when URLs are followed immediately but punctuation such as ',' or '.'. ``` ## Eric Wong, 2017-03-02 07:57 Subject: Re: [PATCH] README: create HTTP/HTTPS links from URLs in Markdown Message-ID: <20170302075709.GA6295@starla> URL: https://gitlist.dev/e/20170302075709.GA6295%40starla In-Reply-To: <20170302073708.dxm4p24pt6zlqjuz@sigill.intra.peff.net> ``` Jeff King wrote: > On Thu, Mar 02, 2017 at 07:34:21AM +0000, Eric Wong wrote: > > Jeff King wrote: > > > On Wed, Mar 01, 2017 at 10:22:04PM +0000, Eric Wong wrote: > > > > > > > Markdown supports automatic links by surrounding URLs with > > > > angle brackets, as documented in > > > > > > > > > > One of the joys of markdown is that there are so many variants. A lot of > > > them (including GitHub-flavored markdown) will linkify URLs even when > > > they're not inside angle brackets. > > > > > > So I don't mind this patch, but I'm curious what's rendering the > > > markdown you're seeing. I'd think online that one would either come > > > across the raw text, or the GFM from https://github.com/git/git. > > > > I was using Gruber's reference implementation from Debian stable > > (1.0.1-7). > > OK. I guess my question more was "why are you doing that?". I'd expect > people to find the GFM rendering on GitHub, or just look at the text via > "less". Actually, I was initially seeing the lack of trailing slash causing unnecessary 301 redirects on public-inbox.org. So, I added the trailing slash and ran "markdown But it's not really my business why you would want to do it. :) It's > reasonable for us to cater to the common subset of renderers. :) I figure somebody unfamiliar with Markdown editing README.md is likely to run the original implementation locally to check their work, as I did. (hmm... and vger is unusually slow this week) ``` ## Jeff King, 2017-03-02 07:18 Subject: Re: [PATCH] README: create HTTP/HTTPS links from URLs in Markdown Message-ID: <20170302071810.pbczh3p4w4bnyqzg@sigill.intra.peff.net> URL: https://gitlist.dev/e/20170302071810.pbczh3p4w4bnyqzg%40sigill.intra.peff.net In-Reply-To: <20170301222204.GA5413@whir> ``` On Wed, Mar 01, 2017 at 10:22:04PM +0000, Eric Wong wrote: > Markdown supports automatic links by surrounding URLs with > angle brackets, as documented in > One of the joys of markdown is that there are so many variants. A lot of them (including GitHub-flavored markdown) will linkify URLs even when they're not inside angle brackets. So I don't mind this patch, but I'm curious what's rendering the markdown you're seeing. I'd think online that one would either come across the raw text, or the GFM from https://github.com/git/git. -Peff ```