Content-Type: text/plain;
	charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3774.400.31\))
Subject: Re: An improved README experience for PostgreSQL
From: "David E. Wheeler" <david@justatheory.com>
In-Reply-To: <202402281851.37k26w47cced@alvherre.pgsql>
Date: Wed, 28 Feb 2024 13:54:59 -0500
Cc: Joe Conway <mail@joeconway.com>,
 Daniel Gustafsson <daniel@yesql.se>,
 Nathan Bossart <nathandbossart@gmail.com>,
 Tom Lane <tgl@sss.pgh.pa.us>,
 Andrew Atkinson <andyatkinson@gmail.com>,
 PostgreSQL Hackers <pgsql-hackers@postgresql.org>,
 Samay Sharma <samay@tembo.io>
Content-Transfer-Encoding: quoted-printable
Message-Id: <C1E66A64-8923-4634-8A95-EE00743CECA0@justatheory.com>
References: <202402281851.37k26w47cced@alvherre.pgsql>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Archived-At: <https://www.postgresql.org/message-id/C1E66A64-8923-4634-8A95-EE00743CECA0%40justatheory.com>
Precedence: bulk

On Feb 28, 2024, at 1:51=E2=80=AFPM, Alvaro Herrera =
<alvherre@alvh.no-ip.org> wrote:
=20
> *IF* people don't go overboard, yes.  I agree, but let's keep an eye =
so
> that it doesn't become an unreadable mess.  I've seen some really
> horrible markdown files that I'm sure most of you would object to.

Markdown++

IME the keys to decent-looking Markdown are:

1. Wrapping lines to a legible width (76-80 chars)
2. Link references rather than inline links

I try to follow these for my blog; posts end up looking like this:

https://justatheory.com/2024/02/extension-metadata-typology.text

(Append `.text` to any post to see the raw(ish) Markdown.

Best,

David